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

Enhancement: update MkDocs version #2498

Closed
6 tasks done
waldekmastykarz opened this issue Jun 11, 2021 · 5 comments
Closed
6 tasks done

Enhancement: update MkDocs version #2498

waldekmastykarz opened this issue Jun 11, 2021 · 5 comments
Assignees
@waldekmastykarz
Labels
docs work in progress
Milestone
v4.2

Comments

@waldekmastykarz
Copy link
Member

waldekmastykarz commented Jun 11, 2021 •
edited

Currently, we're building our docs using MkDocs Material 3.0.1 which is 3 years old. We should upgrade MkDocs to the latest version v7.1.7 to get the latest improvements and avoid future surprises.

  • upgrade mkdocs config
  • upgrade all content tabs to new format
  • fix PowerShell comparison rendering (table is cut off in width)
  • update CI/CD
  • update devcontainer.json
  • Update MPA in the Wiki (after merging the PR)
@waldekmastykarz waldekmastykarz self-assigned this Jun 11, 2021
@garrytrinder
Copy link
Member

We should also update devcontainer.json to match the new version.

@waldekmastykarz
Copy link
Member Author

waldekmastykarz commented Jun 17, 2021 •
edited

Putting it on hold for now to focus on features for v4. Work in progress is at https://github.com/waldekmastykarz/cli-microsoft365/tree/upgrade-mkdocs

@waldekmastykarz waldekmastykarz removed their assignment Jun 17, 2021
@waldekmastykarz waldekmastykarz mentioned this issue Sep 6, 2021
Closed
@waldekmastykarz waldekmastykarz mentioned this issue Sep 23, 2021
Closed
@waldekmastykarz waldekmastykarz self-assigned this Oct 17, 2021
@waldekmastykarz
Copy link
Member Author

I've got all changes in my branch @ https://github.com/waldekmastykarz/cli-microsoft365/tree/upgrade-mkdocs. @garrytrinder could you please double check that I haven't missed anything in Docker and devcontainer?

@garrytrinder
Copy link
Member

Tested in Codespaces, all working as expected 🚀

@waldekmastykarz
Copy link
Member Author

Awesome! Let me have a last look and submit a PR 🚀

waldekmastykarz added a commit to waldekmastykarz/cli-microsoft365 that referenced this issue Oct 17, 2021
@waldekmastykarz
Upgrades MkDocs to 7.1.7. Closes pnp#2498
f018398
@waldekmastykarz waldekmastykarz mentioned this issue Oct 17, 2021
Closed
@waldekmastykarz waldekmastykarz added this to the v4.2 milestone Oct 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@waldekmastykarz waldekmastykarz

Labels
docs work in progress
Projects
None yet
Milestone
v4.2
Development

Successfully merging a pull request may close this issue.

Upgrades MkDocs to 7.1.7. Closes #2498 waldekmastykarz/cli-microsoft365
2 participants
@waldekmastykarz @garrytrinder