Add dashboard sync config

[AlanGreene]

Changes

tektoncd/dashboard#1215

We've added the initial _index.md file from the Dashboard docs
to the Dashboard repo, so adding the repo to the sync config.

Waiting for tektoncd/dashboard#1268 to be merged first.

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

• Includes docs (if user facing)
• Commit messages follow commit message best practices

See the contribution guide
for more details.

[netlify]

Deploy request for tekton pending review.

Review with commit 6ca4340

https://app.netlify.com/sites/tekton/deploys

[AlanGreene]

@steveodonovan @a-roberts fyi, first step to getting more dashboard content on the website and cleaning up our docs.

[tualeron]

/kind documentation

[a-roberts]

Looks all good here

/lgtm

(I'll be impressed if my lgtm here counts from a Prow perspective 😄 )

[afrittoli]

It looks good, the only concern I have is the tag that we are pulling here.
That said we may be using master for other repos too, but that's something we need to fix!

[afrittoli]

Should we pull the latest released version instead of master here?

[AlanGreene]

We're pulling master for the other projects already so I went for consistency here. It looks like there's some rudimentary support for multiple versions baked in but it just links to the project repo rather than hosting the versioned docs on the website.

We should discuss this at the docs working group and maybe the broader group too to agree a proper strategy.

Also related: #88 and #34

[AlanGreene]

Forgot to add this after the call...

Discussed this at the docs working group on April 22nd. With our current approach, switching the sync script to pull specific release tags instead of master means we wouldn't be able to publish updated docs between releases.

Options:

• patch version releases for doc updates if needed
• change sync script to be more flexible (what would the strategy be?)
• ???

Also discussed current support for multiple versions:

• Items under 'Previous Releases' not obviously clickable at first glance
• clicking 'Archived Versions' brings user to the project repo's 'Tags' page, not obvious how to get to desired docs from there unless familiar with the project structure (select relevant tag, find docs folder, find correct file)

[popcor255]

@afrittoli @AlanGreene PR I think this will give us the flexibility we want.

[AlanGreene]

updated to pull v0.6.1.4 as the default, with master listed under 'Previous releases' (maybe we should rename that section to 'Other versions' or something?)

[AlanGreene]

@popcor255 once we resolve #130 this PR should be good to go. I'll add some details to the issue about navigation from the 'vault' view back to the main docs experience and we can decide what we want to do to improve it before enabling multiple versions.

[popcor255]

/lgtm

[popcor255]

/assign @sbwsg @vdemeester

[AlanGreene]

/hold

[tekton-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: sbwsg
To complete the pull request process, please assign alangreene
You can assign the PR to them by writing /assign @alangreene 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:

• OWNERS

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

[vdemeester]

@AlanGreene what is the status ? 📦

[AlanGreene]

There are a number of issues with the current sync approach:

• it's easy for an individual project to break the sync for all, this has already happened a few times where files were moved/renamed and the website sync config wasn't updated
• docs are currently tracking master, we want to change this to track the latest releases with option to view previous releases. See Changes for Sync to Multiple Releases #130 for some related discussion
• links to edit the docs / open issues are hard to get right with the current setup, we've fixed this before but it seems broken again. Links point to the website repo instead of the individual project repos
• links between docs are tricky too, having them work both on the website and on GitHub is difficult due to the way links are rewritten for the website (e.g. mydoc.md becomes mydoc/ on the website, and relative links from it break)

@wlynch has a proposal in #140 to give more direct control to the individual projects that will help to solve many of these.

I'm going to close this PR and we can revisit after #140 unless there's an urgent need to surface more Dashboard docs on the website.