Skip to content

docs: restructure docs #14421

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

Merged
merged 238 commits into from
Oct 5, 2024
Merged

docs: restructure docs #14421

merged 238 commits into from
Oct 5, 2024

Conversation

matifali
Copy link
Member

@matifali matifali commented Aug 23, 2024

Closes #13434
Supersedes #14182

matifali and others added 22 commits August 24, 2024 22:35
- Improve JSON formatting by adding line breaks for array items
- Shorten "Control Plane Configuration" to "Control Plane" for clarity
Remove outdated introduction and table of contents from the
administration README to improve clarity in the doc structure.

- Eliminated prerequisites and content list placeholders
- Redirected readers to the respective sections for detailed content
Users require these links to correctly configure their git providers.

- GitHub Enterprise: ../configure.md#github-enterprise
- GitLab: ../configure.md#gitlab-self-managed
- BitBucket: ../configure.md#bitbucket-server
- Other Providers: ../configure.md#external-authentication
- Enhance document structure by renaming the main heading.
- Implement XML-style child linking for future content inclusion.
@bpmct bpmct marked this pull request as ready for review October 5, 2024 02:47
Copy link
Member

@bpmct bpmct left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We went through a thorough QA session and it's ready. There may be some slip-ups but we're ready to 🚢

bpmct and others added 4 commits October 5, 2024 11:41
This commit eliminates outdated documentation files and updates the JSON formatting in the docs manifest for improved readability and consistency.
@stirby stirby merged commit 419eba5 into main Oct 5, 2024
29 of 30 checks passed
@stirby stirby deleted the restructure-new branch October 5, 2024 15:52
@github-actions github-actions bot locked and limited conversation to collaborators Oct 5, 2024
@matifali
Copy link
Member Author

/cherry-pick test-cherry-pick-2.10

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

☂️ Restructure our docs
5 participants