Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add installation instructions to website #377

Closed
wants to merge 1 commit into from

Conversation

geriom
Copy link
Contributor

@geriom geriom commented May 10, 2022

Changes

This adds the installation instructions to the website under the same
section, for visibility and ease of navigation. There's no new
information from what you can find on the repo docs for each component,
but the installation instructions are presented in a cohesive way,
following the same style and structure to provide a better experience
for the user.

This also fixes some minor formatting errors and updates links in the
"Getting started" tutorials.

/closes #4553

Docs Preview

Submitter Checklist

See the contribution guide
for more details.

@geriom geriom requested review from afrittoli and dibyom May 10, 2022 15:33
@tekton-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign geriom
You can assign the PR to them by writing /assign @geriom in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label May 10, 2022
@geriom geriom mentioned this pull request May 10, 2022
2 tasks
This adds the installation instructions to the website under the same
section, for visibility and ease of navigation. There's no new
information from what you can find on the repo docs for each component,
but the installation instructions are presented in a cohesive way,
following the same style and structure to provide a better experience
for the user.

This also fixes some minor formatting errors and updates links in the
"Getting started" tutorials.

This section provides instructions to install different Tekton components on
your cluster. To proceed with the installation you must already have a cluster
with the correct permissions and [kubectl] installed and configured.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we elaborate what the correct permissions are?

<!--
---
title: "Install Tekton Dashboard"
linkTitle: "Tekton Dashboard"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the component specific installation pages, is it possible to have the pages in the projects themselves and pull the content from there? Otherwise, anytime a component's installation process changes , we'd have to update the website page separately.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm... I recently submitted a PR to upstream Docsy that adds a shorcode to include the contents of one file into another. We can use that to have the Installation content under the same section while keeping it in the repo.

Thanks for the suggestions. I'll look into that.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Installation instructions must be versioned, same as the reference docs, so the instructions shown here must change when a different version is picked from the dropdown.

It may be possible to handle that through the sync script, but if we can get more native support in docsy that's even better.

I think the main disconnect between Tekton and Docsy is that Tekton has multiple components released independently, and I don't think Docsy natively supports that?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docsy supports versioning but for the entire docset, not for individual files or folders. But we already have a shortcode for the synced docs, we can make something similar for the installation.

It may be possible to handle that through the sync script

I was going through the script to figure out the best way to do it. I think it should be possible with the current functions. I'll close this PR and come up with a solution after I'm done with a few other PRs I'm currently working on.

@geriom geriom mentioned this pull request May 16, 2022
6 tasks
@geriom geriom closed this Jun 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Write a user-friendly introductory setup guide.
4 participants