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.

Sign up for GitHub

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

Jump to bottom

docs: documentation updates #467

Merged
merged 1 commit into from
Jan 12, 2024
Merged

docs: documentation updates #467

merged 1 commit into from
Jan 12, 2024

Conversation

tenthirtyam
Copy link
Collaborator

Summary

  • Updates installation documentation for the v2.8.0 release.
  • Updates the MkDocs plugin requirements.
  • Updates the MkDocs configuration to include missing functions.

Type

  • Bugfix
  • Enhancement or Feature
  • Code Style or Formatting
  • Documentation
  • Refactoring
  • Chore
  • Other
    Please describe:

Breaking Changes?

  • Yes, there are breaking changes.
  • No, there are no breaking changes.

Test and Documentation

  • Tests have been completed.
  • Documentation has been added or updated.
power-validated-solutions-for-cloud-foundation on  docs/update-documentation 
➜ make docs-install   
pip install mkdocs-material
Collecting mkdocs-material
  Using cached mkdocs_material-9.5.3-py3-none-any.whl.metadata (16 kB)
Requirement already satisfied: babel~=2.10 in /usr/local/lib/python3.11/site-packages (from mkdocs-material) (2.12.1)
Requirement already satisfied: colorama~=0.4 in /usr/local/lib/python3.11/site-packages (from mkdocs-material) (0.4.6)
Requirement already satisfied: jinja2~=3.0 in /usr/local/lib/python3.11/site-packages (from mkdocs-material) (3.1.2)
Requirement already satisfied: markdown~=3.2 in /usr/local/lib/python3.11/site-packages (from mkdocs-material) (3.5.2)
Requirement already satisfied: mkdocs-material-extensions~=1.3 in /usr/local/lib/python3.11/site-packages (from mkdocs-material) (1.3.1)
Collecting mkdocs~=1.5.3 (from mkdocs-material)
  Using cached mkdocs-1.5.3-py3-none-any.whl.metadata (6.2 kB)
Requirement already satisfied: paginate~=0.5 in /usr/local/lib/python3.11/site-packages (from mkdocs-material) (0.5.6)
Requirement already satisfied: pygments~=2.16 in /usr/local/lib/python3.11/site-packages (from mkdocs-material) (2.17.2)
Requirement already satisfied: pymdown-extensions~=10.2 in /usr/local/lib/python3.11/site-packages (from mkdocs-material) (10.5)
Requirement already satisfied: regex>=2022.4 in /usr/local/lib/python3.11/site-packages (from mkdocs-material) (2023.10.3)
Requirement already satisfied: requests~=2.26 in /usr/local/lib/python3.11/site-packages (from mkdocs-material) (2.31.0)
Requirement already satisfied: MarkupSafe>=2.0 in /usr/local/lib/python3.11/site-packages (from jinja2~=3.0->mkdocs-material) (2.1.3)
Requirement already satisfied: click>=7.0 in /usr/local/lib/python3.11/site-packages (from mkdocs~=1.5.3->mkdocs-material) (8.1.7)
Requirement already satisfied: ghp-import>=1.0 in /usr/local/lib/python3.11/site-packages (from mkdocs~=1.5.3->mkdocs-material) (2.1.0)
Requirement already satisfied: mergedeep>=1.3.4 in /usr/local/lib/python3.11/site-packages (from mkdocs~=1.5.3->mkdocs-material) (1.3.4)
Requirement already satisfied: packaging>=20.5 in /usr/local/lib/python3.11/site-packages (from mkdocs~=1.5.3->mkdocs-material) (23.2)
Requirement already satisfied: pathspec>=0.11.1 in /usr/local/lib/python3.11/site-packages (from mkdocs~=1.5.3->mkdocs-material) (0.12.1)
Requirement already satisfied: platformdirs>=2.2.0 in /usr/local/lib/python3.11/site-packages (from mkdocs~=1.5.3->mkdocs-material) (4.1.0)
Requirement already satisfied: pyyaml-env-tag>=0.1 in /usr/local/lib/python3.11/site-packages (from mkdocs~=1.5.3->mkdocs-material) (0.1)
Requirement already satisfied: pyyaml>=5.1 in /usr/local/lib/python3.11/site-packages (from mkdocs~=1.5.3->mkdocs-material) (6.0.1)
Requirement already satisfied: watchdog>=2.0 in /usr/local/lib/python3.11/site-packages (from mkdocs~=1.5.3->mkdocs-material) (3.0.0)
Requirement already satisfied: charset-normalizer<4,>=2 in /usr/local/lib/python3.11/site-packages (from requests~=2.26->mkdocs-material) (3.3.2)
Requirement already satisfied: idna<4,>=2.5 in /usr/local/lib/python3.11/site-packages (from requests~=2.26->mkdocs-material) (3.6)
Requirement already satisfied: urllib3<3,>=1.21.1 in /usr/local/lib/python3.11/site-packages (from requests~=2.26->mkdocs-material) (2.1.0)
Requirement already satisfied: certifi>=2017.4.17 in /usr/local/lib/python3.11/site-packages (from requests~=2.26->mkdocs-material) (2023.11.17)
Requirement already satisfied: python-dateutil>=2.8.1 in /usr/local/lib/python3.11/site-packages (from ghp-import>=1.0->mkdocs~=1.5.3->mkdocs-material) (2.8.2)
Requirement already satisfied: six>=1.5 in /usr/local/lib/python3.11/site-packages (from python-dateutil>=2.8.1->ghp-import>=1.0->mkdocs~=1.5.3->mkdocs-material) (1.16.0)
Using cached mkdocs_material-9.5.3-py3-none-any.whl (8.6 MB)
Using cached mkdocs-1.5.3-py3-none-any.whl (3.7 MB)
Installing collected packages: mkdocs, mkdocs-material
Successfully installed mkdocs-1.5.3 mkdocs-material-9.5.3
pip install --requirement docs/requirements.txt
Collecting mkdocs-git-revision-date-localized-plugin>=1.2.2 (from -r docs/requirements.txt (line 1))
  Using cached mkdocs_git_revision_date_localized_plugin-1.2.2-py3-none-any.whl.metadata (4.8 kB)
Collecting mkdocs-markdownextradata-plugin>=0.2.5 (from -r docs/requirements.txt (line 2))
  Using cached mkdocs_markdownextradata_plugin-0.2.5-py3-none-any.whl
Collecting mkdocs-minify-plugin>=0.7.2 (from -r docs/requirements.txt (line 3))
  Using cached mkdocs_minify_plugin-0.7.2-py3-none-any.whl.metadata (4.0 kB)
Collecting mkdocs-open-in-new-tab>=1.0.3 (from -r docs/requirements.txt (line 4))
  Using cached mkdocs_open_in_new_tab-1.0.3-py3-none-any.whl.metadata (5.8 kB)
Requirement already satisfied: mkdocs>=1.0 in /usr/local/lib/python3.11/site-packages (from mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (1.5.3)
Requirement already satisfied: GitPython in /usr/local/lib/python3.11/site-packages (from mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (3.1.37)
Requirement already satisfied: babel>=2.7.0 in /usr/local/lib/python3.11/site-packages (from mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (2.12.1)
Requirement already satisfied: pytz in /usr/local/lib/python3.11/site-packages (from mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (2023.3.post1)
Requirement already satisfied: pyyaml in /usr/local/lib/python3.11/site-packages (from mkdocs-markdownextradata-plugin>=0.2.5->-r docs/requirements.txt (line 2)) (6.0.1)
Requirement already satisfied: htmlmin2>=0.1.13 in /usr/local/lib/python3.11/site-packages (from mkdocs-minify-plugin>=0.7.2->-r docs/requirements.txt (line 3)) (0.1.13)
Requirement already satisfied: jsmin>=3.0.1 in /usr/local/lib/python3.11/site-packages (from mkdocs-minify-plugin>=0.7.2->-r docs/requirements.txt (line 3)) (3.0.1)
Requirement already satisfied: csscompressor>=0.9.5 in /usr/local/lib/python3.11/site-packages (from mkdocs-minify-plugin>=0.7.2->-r docs/requirements.txt (line 3)) (0.9.5)
Requirement already satisfied: click>=7.0 in /usr/local/lib/python3.11/site-packages (from mkdocs>=1.0->mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (8.1.7)
Requirement already satisfied: ghp-import>=1.0 in /usr/local/lib/python3.11/site-packages (from mkdocs>=1.0->mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (2.1.0)
Requirement already satisfied: jinja2>=2.11.1 in /usr/local/lib/python3.11/site-packages (from mkdocs>=1.0->mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (3.1.2)
Requirement already satisfied: markdown>=3.2.1 in /usr/local/lib/python3.11/site-packages (from mkdocs>=1.0->mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (3.5.2)
Requirement already satisfied: markupsafe>=2.0.1 in /usr/local/lib/python3.11/site-packages (from mkdocs>=1.0->mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (2.1.3)
Requirement already satisfied: mergedeep>=1.3.4 in /usr/local/lib/python3.11/site-packages (from mkdocs>=1.0->mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (1.3.4)
Requirement already satisfied: packaging>=20.5 in /usr/local/lib/python3.11/site-packages (from mkdocs>=1.0->mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (23.2)
Requirement already satisfied: pathspec>=0.11.1 in /usr/local/lib/python3.11/site-packages (from mkdocs>=1.0->mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (0.12.1)
Requirement already satisfied: platformdirs>=2.2.0 in /usr/local/lib/python3.11/site-packages (from mkdocs>=1.0->mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (4.1.0)
Requirement already satisfied: pyyaml-env-tag>=0.1 in /usr/local/lib/python3.11/site-packages (from mkdocs>=1.0->mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (0.1)
Requirement already satisfied: watchdog>=2.0 in /usr/local/lib/python3.11/site-packages (from mkdocs>=1.0->mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (3.0.0)
Requirement already satisfied: gitdb<5,>=4.0.1 in /usr/local/lib/python3.11/site-packages (from GitPython->mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (4.0.10)
Requirement already satisfied: python-dateutil>=2.8.1 in /usr/local/lib/python3.11/site-packages (from ghp-import>=1.0->mkdocs>=1.0->mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (2.8.2)
Requirement already satisfied: smmap<6,>=3.0.1 in /usr/local/lib/python3.11/site-packages (from gitdb<5,>=4.0.1->GitPython->mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (5.0.1)
Requirement already satisfied: six>=1.5 in /usr/local/lib/python3.11/site-packages (from python-dateutil>=2.8.1->ghp-import>=1.0->mkdocs>=1.0->mkdocs-git-revision-date-localized-plugin>=1.2.2->-r docs/requirements.txt (line 1)) (1.16.0)
Using cached mkdocs_git_revision_date_localized_plugin-1.2.2-py3-none-any.whl (21 kB)
Using cached mkdocs_minify_plugin-0.7.2-py3-none-any.whl (6.5 kB)
Using cached mkdocs_open_in_new_tab-1.0.3-py3-none-any.whl (6.7 kB)
Installing collected packages: mkdocs-open-in-new-tab, mkdocs-minify-plugin, mkdocs-markdownextradata-plugin, mkdocs-git-revision-date-localized-plugin
Successfully installed mkdocs-git-revision-date-localized-plugin-1.2.2 mkdocs-markdownextradata-plugin-0.2.5 mkdocs-minify-plugin-0.7.2 mkdocs-open-in-new-tab-1.0.3

power-validated-solutions-for-cloud-foundation on  docs/update-documentation took 11.0s 
➜ make docs-serve-live
mkdocs serve --livereload -w ./
INFO    -  DeprecationWarning: warning_filter doesn't do anything since MkDocs 1.2 and will be removed soon. All messages on the `mkdocs` logger get counted automatically.
             File "/usr/local/lib/python3.11/site-packages/markdownextradata/plugin.py", line 8, in <module>
               from mkdocs.utils import warning_filter
             File "/usr/local/lib/python3.11/site-packages/mkdocs/utils/__init__.py", line 453, in __getattr__
               warnings.warn(
INFO    -  Building documentation...
INFO    -  Cleaning site directory
INFO    -  Documentation built in 27.64 seconds
INFO    -  [16:19:03] Watching paths for changes: 'docs', 'mkdocs.yml', '.'
INFO    -  [16:19:03] Serving on http://127.0.0.1:8000/power-validated-solutions-for-cloud-foundation/

Issue References

Additional Information

@tenthirtyam
docs: documentation updates
a38ebff 
- Updates installation documentation for the v2.8.0 release.
- Updates the MkDocs plugin requirements.
- Updates the MkDocs configuration to include missing functions.

Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
@tenthirtyam tenthirtyam added the documentation Documentation label Jan 11, 2024
@tenthirtyam tenthirtyam added this to the v2.8.0 milestone Jan 11, 2024
@tenthirtyam tenthirtyam self-assigned this Jan 11, 2024
@tenthirtyam tenthirtyam requested a review from a team as a code owner January 11, 2024 21:20
@github-actions github-actions bot added the needs-review Needs Review label Jan 11, 2024
@tenthirtyam tenthirtyam removed the needs-review Needs Review label Jan 12, 2024
@tenthirtyam tenthirtyam merged commit 157c75d into develop Jan 12, 2024
3 checks passed
@tenthirtyam tenthirtyam deleted the docs/update-documentation branch January 12, 2024 23:52
@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 2, 2024

I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@nickmarshall9 nickmarshall9 Awaiting requested review from nickmarshall9

Assignees

@tenthirtyam tenthirtyam

Labels
cla-not-required documentation Documentation
Projects
None yet
Milestone
v2.8.0
Development

Successfully merging this pull request may close these issues.
2 participants
@tenthirtyam @vmwclabot