-
Notifications
You must be signed in to change notification settings - Fork 151
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
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
9d471db
to
325fde6
Compare
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.
325fde6
to
f7adefb
Compare
|
||
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. |
There was a problem hiding this comment.
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" |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
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.