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

Clarify which doc version to fix #4895

Closed
t-kikuc opened this issue Apr 23, 2024 · 1 comment
Closed

Clarify which doc version to fix #4895

t-kikuc opened this issue Apr 23, 2024 · 1 comment
Labels
area/docs kind/enhancement New feature or request

Comments

@t-kikuc
Copy link
Member

t-kikuc commented Apr 23, 2024

What would you like to be added:

  • Redefine and clarify the rule of contributing to docs, focusing on which doc version to fix.
    cf. Our current rule: https://github.com/pipe-cd/pipecd/tree/master/docs

  • [optional] If possible, it would be better to inform contributors before opening PRs.
    (e.g. Auto check in CI? PullRequest template?)

Why is this needed:

  • Newer contributors often make mistakes of which version to fix (dev, v0.N.x(latest), and older)
  • It takes time for both contributors and reviewers to fix it.
@t-kikuc t-kikuc added kind/enhancement New feature or request area/docs labels Apr 23, 2024
@t-kikuc
Copy link
Member Author

t-kikuc commented Sep 26, 2024

pipecd/docs/README.md

Lines 15 to 21 in 997339c

Here are the flow of docs contribution regard some known scenarios:
1. Update docs that are related to a specified version (which is not the latest released version):
In such case, update the docs under `/docs-v0.x.x` is enough.
2. Update docs for not yet released features or changes:
In such case, update the docs under `/docs-dev` is enough.
3. Update docs that are related to the latest released docs version:
Change the docs' content that fixes the issue under `/docs-dev` and `/docs-v0.x.x`, they share the same file structure so you should find the right files in both directories.
exists

@t-kikuc t-kikuc closed this as completed Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs kind/enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant