Adds "commented" website front matter to docs #500
Conversation
This change adds the front matter needed for the website without altering the site markdown or adding titles. It does this by adding the front matter in comment tags. The tutorial and install are not part of the website currently so links to them under docs/ use absolute urls to allow them to work in both the website and in the pipeline repo
|
/retest |
docs/README.md
Outdated
| @@ -19,5 +28,5 @@ See the following links for more on each of the resources involved: | |||
|
|
|||
| ## Getting Started Tasks | |||
|
|
|||
| - [Create an Ingress on the EventListener Service](create-ingress.yaml) | |||
| - [Create a GitHub webhook](create-webhook.yaml) | |||
| - [Create an Ingress on the EventListener Service](https://github.com/tektoncd/triggers/blob/master/docs/create-ingress.yaml) | |||
There was a problem hiding this comment.
Having the branch hard coded here would break links to any new versioned docs that we have here: https://github.com/tektoncd/triggers#read-the-docs
Do we need to keep the absolute urls forever or can that be changed back when its part of the website?
There was a problem hiding this comment.
Definitely short term.
Let me see if I can workaround that as everything under docs should come as a unit. The "sync" done by the website is currently very simple and does not pick-up files that are not markdown.
There was a problem hiding this comment.
One option is to leave it as a broken link in the website until we can figure out the right thing to do. I have no problem err-ing on the side of keeping our current github doc pristine.
There was a problem hiding this comment.
Cool, let's keep the relative links for now then.
For now we'll continue to use relative links for non-markdown resources which will make our links broken in the website however we will fix this later. I have left the "image" as an absolute URL (short-term) as I feel that is essential for the docs and hopefully will not change in the short-term.
Not sure why the linter is failing for this in this PR 🤔 |
|
well... why not try another... |
|
@skaegi I'll look into the linter issue....to unblock this PR would you mind making the lint change..it should be simple... |
No need to fmt.Sprintf here.
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: dibyom The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
This change adds the front matter needed for the website without altering the site markdown or adding titles. It does this by adding the front matter in comment tags.
The tutorial and install are not part of the website currently so links to them under docs/ use absolute urls to allow them to work in both the website and in the pipeline repo
Changes
update /docs markdown files with front matter
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
See the contribution guide for more details.