docs: Fix naming consistency, typos, and improve sample references #2186
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Copilot
AI
changed the title
[WIP] analyze the documentation see any issues with it
docs: Fix naming consistency, typos, and improve sample references
Jul 24, 2025
Copilot finished work on behalf of
chmouel
July 24, 2025 22:11
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses several documentation issues identified during a comprehensive analysis of the Pipelines-as-Code documentation.
Issues Fixed
1. Inconsistent Project Naming
Fixed inconsistent naming throughout the documentation where "Pipelines As Code" (with spaces) was used instead of the correct "Pipelines-as-Code" (with hyphens):
docs/content/docs/install/installation.md(3 instances)docs/content/docs/install/settings.md(1 instance)2. Typos in Sample Files
Corrected spelling errors in sample configuration files:
samples/repository-secret.yaml(2 instances)3. Missing Sample References
Added documentation references to existing sample files that were not mentioned in the docs:
docs/content/docs/guide/repositorycrd.mdpointing users to the sample Repository CR configurations in the/samples/directoryValidation
Files Changed
docs/content/docs/install/installation.mddocs/content/docs/install/settings.mddocs/content/docs/guide/repositorycrd.mdsamples/repository-secret.yamlThese changes improve the overall quality and consistency of the Pipelines-as-Code documentation while making it easier for users to find relevant examples.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.