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 Docs Check to Pull Request CI #692

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

Add Docs Check to Pull Request CI #692

adambkaplan opened this issue Mar 24, 2021 · 5 comments
Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation.
Milestone

Comments

@adambkaplan
Copy link
Member

adambkaplan commented Mar 24, 2021

Issue

The community has decided to keep reference documentation in the same tree as code to facilitate high quality contributions.
To publish this documentation, the website repo will utilize a sync script that copy docs markdown from the code repositories to the website repo, which then generates the static HTML.
In order for the website to render correctly, "front matter" metadata needs to be embedded in the markdown stored in code repositories.

Proposed Solution

Add a "docs" GitHub action in shipwright-io/build (and future repositories) which checks out the website code, runs the sync, and then has hugo generate the static content.
Failures here will need to have clear messaging so contributors know what went wrong and how to fix it.

Hopefully we will catch 90% of bugs that would cause the Netlify deployment to fail from synced content.

Notes

Depends on shipwright-io/website#29

Originally posted by @adambkaplan in shipwright-io/website#27 (comment)

@adambkaplan adambkaplan added this to the release-v0.5.0 milestone Apr 7, 2021
@adambkaplan adambkaplan added kind/documentation Categorizes issue or PR as related to documentation. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels Apr 7, 2021
@qu1queee
Copy link
Contributor

qu1queee commented May 5, 2021

@adambkaplan from grooming session, can you provide the status of this one pls?

@adambkaplan
Copy link
Member Author

This still depends on the website issue, which is currently open.

@qu1queee
Copy link
Contributor

@adambkaplan is this something that is already done?

@qu1queee
Copy link
Contributor

from grooming:

  • do we need to start versioning on the docs in the website?

@adambkaplan
Copy link
Member Author

Website issue is still open.

do we need to start versioning on the docs in the website?

Since we are still in an alpha phase, I don't think versioned docs is necessary. I think once we have a more stable API (v1beta1) then versioned docs make sense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

3 participants