docs: Add Developer Resources documentation to Documentation menu #1900
Conversation
aThorp96
force-pushed
the
dev-docs-fix
branch
3 times, most recently
from
036d1fb to
5c348b5
Compare
|
/lgtm |
aThorp96
force-pushed
the
dev-docs-fix
branch
from
5c348b5 to
469439f
Compare
|
SGTM any chance you can add that link to the contributing section of the README as well https://github.com/openshift-pipelines/pipelines-as-code/tree/main?tab=readme-ov-file#contributing |
|
and hack/dev/kind too
|
The Developer Resources page was previously inaccessible via the static site except through the site's search results.
Since CI/CD is often written and maintained by developers, using the term "Contributor" more-clearly distinguishes the target of the developer docs, since they are targetted at developers attempting to contribute to PaC
aThorp96
force-pushed
the
dev-docs-fix
branch
from
469439f to
e61acb5
Compare
|
Good catch @chmouel, thanks. Done That does make me think: I wonder if markdownlint could either detect dead links in a PR and/or detect dead links to internal documentation 🤔 Out of scope for this PR of course but the thought is rattling around in my brain now 😄 |
|
just a note we prefer squashed commits (in tektoncd/ as well) it's fine now but next time please squash the commits unless it's distinctive features/commits that are not related |
|
Thanks @chmouel! For squash commits, do we generally prefer one commit per PR or to squash into atomic changes? |
|
@aThorp96 https://pipelinesascode.com/docs/dev/ is 404 not found can you take a look: |
|
@mathur07 I was just asking Chmouel about this lol This change is merged but the main site only gets updated when a new release is cut. You can find "bleeding edge" docs on https://main.pipelines-as-code.pages.dev/docs/dev/ or https://nightly.pipelines-as-code.pages.dev/docs/dev/ |
|
ah yeah there is as well:
https://docs.pipelinesascode.com/
but i never got into making it generating nightly or promot that url
… On 11 Feb 2025, at 19:14, Andrew Thorp ***@***.***> wrote:
@mathur07 <https://github.com/mathur07> I was just asking Chmouel about this lol
This change is merged but the main site only gets updated when a new release is cut. You can find "bleeding edge" docs on https://main.pipelines-as-code.pages.dev/docs/dev/ or https://nightly.pipelines-as-code.pages.dev/docs/dev/
—
Reply to this email directly, view it on GitHub <#1900 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAYFJDMTDEIJD2XWKQWV7D2PI4X5AVCNFSM6AAAAABWIDYG6OVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMNJRGYZTMNBTGM>.
You are receiving this because you were mentioned.
|
Thanks! |
Changes
Enable users to access the Developer Resources documentation (renamed Contributor Resources) from the side-menu on the site
Submitter Checklist
📝 Ensure your commit message is clear and informative. Refer to the How to write a git commit message guide. Include the commit message in the PR body rather than linking to an external site (e.g., Jira ticket).
♽ Run make test lint before submitting a PR to avoid unnecessary CI processing. Consider installing pre-commit and running pre-commit install in the repository root for an efficient workflow.
✨ We use linters to maintain clean and consistent code. Run make lint before submitting a PR. Some linters offer a --fix mode, executable with make fix-linters (ensure markdownlint and golangci-lint are installed).
📖 Document any user-facing features or changes in behavior.
🧪 While 100% coverage isn't required, we encourage unit tests for code changes where possible.
🎁 If feasible, add an end-to-end test. See README for details.
🔎 Address any CI test flakiness before merging, or provide a valid reason to bypass it (e.g., token rate limitations).
If adding a provider feature, fill in the following details:
(update the documentation accordingly)