Fix: Update GitHub Actions workflow and enhance documentation#2
Merged
Conversation
This commit addresses a build failure by updating the GitHub Actions workflow and includes the previously prepared documentation enhancements. Workflow Updates: - Switched to using the `peaceiris/actions-mkdocs-gh-pages@v4` action for a more robust and maintained deployment process. - Configured the workflow to use Python 3.11. - Dynamically creates a `requirements.txt` for MkDocs dependencies, including `mkdocs-material>=9.0.0` and other necessary plugins. - Enabled the `enable_pdf_export: true` option in the deployment action to handle dependencies for `mkdocs-with-pdf` (e.g., WeasyPrint). - Set `force_push: true` for deployment, consistent with previous behavior. - Workflow now also triggers on pull requests to `main` for pre-merge checks. Documentation Enhancements: - Significantly revamped `index.md`, `whyoca.md`, and `whatisit.md` to improve readability and visual appeal. - Updated `mkdocs.yml` to enable several Material for MkDocs features and PyMdownX extensions (admonitions, Mermaid diagrams, tabs, icons, etc.). - Replaced custom span-based styling with theme-native admonitions and icons. - Restructured content using admonitions, added icons, and placeholders for Mermaid diagrams. - Clarified analogies, improved descriptive text, and added calls to action. These changes aim to ensure successful documentation builds and provide a more engaging, navigable, and effective documentation site for Ops Catalog.
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
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.
This commit addresses a build failure by updating the GitHub Actions workflow and includes the previously prepared documentation enhancements.
Workflow Updates:
peaceiris/actions-mkdocs-gh-pages@v4action for a more robust and maintained deployment process.requirements.txtfor MkDocs dependencies, includingmkdocs-material>=9.0.0and other necessary plugins.enable_pdf_export: trueoption in the deployment action to handle dependencies formkdocs-with-pdf(e.g., WeasyPrint).force_push: truefor deployment, consistent with previous behavior.mainfor pre-merge checks.Documentation Enhancements:
index.md,whyoca.md, andwhatisit.mdto improve readability and visual appeal.mkdocs.ymlto enable several Material for MkDocs features and PyMdownX extensions (admonitions, Mermaid diagrams, tabs, icons, etc.).These changes aim to ensure successful documentation builds and provide a more engaging, navigable, and effective documentation site for Ops Catalog.