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

Doc: Readme updates to align with new Red Hat template #693

Open
wants to merge 2 commits into
base: devel
Choose a base branch
from

Conversation

JulioPDX
Copy link
Contributor

Change Summary

README at the root of the collection has been updated to conform with the new Red Hat collection template. Due to not being able to link to files outside of the Mkdocs docs_dir location, the old README at the root of the collection has been renamed to index.md. This is used as the homepage on the documentation site. The root README for the repository is only used for GitHub.

Proposed changes

Please see the change summary.

How to test

No updates to main site docs.

Checklist

User Checklist

  • N/A

Repository Checklist

  • My code has been rebased from devel before I start
  • I have read the CONTRIBUTING document.
  • My change requires a change to the documentation and documentation have been updated accordingly. (check the box if not applicable)
  • I have updated molecule CI testing accordingly. (check the box if not applicable)

@JulioPDX JulioPDX self-assigned this May 21, 2024
@github-actions github-actions bot added the type: documentation Improvements or additions to documentation label May 21, 2024
Copy link

sonarcloud bot commented May 21, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.2% Duplication on New Code

See analysis details on SonarCloud

@JulioPDX
Copy link
Contributor Author

JulioPDX commented Jun 4, 2024

pre-commit.ci run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant