-
Notifications
You must be signed in to change notification settings - Fork 277
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
[META] Documentation website enhancements w/ engineering support #4455
Comments
Specifically, we're proposing the following changes:
|
Needs more discussion on this specific request. |
From Barani: We can implement similar logic for issues as well. We can work on gating PR merge as future enhancement. |
Have some discussion with Heather offline, and seems like this requires some more testing. If we do the opt-in model where developers need to check a box or add a label, it does not guarantee the issue creation if the label is missed. If we do the opt-out model then the timing of creating such issues and avoid unnecessary noise is key. Still need some thoughts and discussion or even a one pager / poc before proceed with implementation. |
Some ideas to consider: https://about.gitlab.com/blog/2022/10/12/five-fast-facts-about-docs-as-code-at-gitlab/ |
Working on GitHubApp POC and will send one pager design later. |
Seems like core already have a basic workflow for creating the docs issues: |
We have decided on this workflow:
We will also add other checks later such as block PR merge, link backports to original opened issues, and more later, to help the docs team and core/plugin team avoid missing documentations, and start working on those early on. Thanks. |
Is your feature request related to a problem? Please describe
Yes. The Docs as Code process can be improved by adding sign offs to development PRs. This would ensure documentation is created and managed alongside the code.
Describe the solution you'd like
Add a task list item (Documentation) through GitHub Actions.
Describe alternatives you've considered
No response
Additional context
No response
Issues:
The text was updated successfully, but these errors were encountered: