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

Sync Code-Driven Documentation to Website #29

Open
adambkaplan opened this issue Mar 24, 2021 · 0 comments
Open

Sync Code-Driven Documentation to Website #29

adambkaplan opened this issue Mar 24, 2021 · 0 comments

Comments

@adambkaplan
Copy link
Member

The community expressed strong desire for keeping documentation closer to the code repositories (ex - github.com/shipwright-io/build), and syncing that content here. Tekton has an interesting script that facilitates this process [1].

After merging #27, we should adopt/adjust Tekton's sync script [1] to do the following:

  1. Update the folder structure and file front matter in website so the docs are structured and presented to our liking.
  2. Add the appropriate front matter to the docs in build
  3. Incorporate the Tekton sync script (with adjustments as needed) into website.

[1] https://github.com/tektoncd/website/tree/main/sync

Originally posted by @adambkaplan in #27 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant