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

Feature: Use Material for MkDocs as a static site generator for IoT Hub Portal documentation #990

Closed
hocinehacherouf opened this issue Jul 27, 2022 · 0 comments · Fixed by #1010
Closed

Feature: Use Material for MkDocs as a static site generator for IoT Hub Portal documentation #990

hocinehacherouf opened this issue Jul 27, 2022 · 0 comments · Fixed by #1010
Assignees
@hocinehacherouf
Labels
enhancement New feature or request
Milestone
S34

Comments

@hocinehacherouf
Copy link
Contributor

Describe the solution you'd like
We can use mkdocs-material to develop/generate IoT Hub Portal documentation site.

Material for MkDocs proposes the following features:

  • Search (on pre-indexed pages during build time)
  • Customization through templating/plugins. Example: Versioning of documentation
@hocinehacherouf hocinehacherouf added enhancement New feature or request refinement labels Jul 27, 2022
@kbeaugrand kbeaugrand added this to the S34 milestone Aug 1, 2022
@kbeaugrand kbeaugrand moved this to :pencil: Todo in IoT Hub Portal Aug 1, 2022
@hocinehacherouf hocinehacherouf self-assigned this Aug 2, 2022
@hocinehacherouf hocinehacherouf moved this from :pencil: Todo to :construction: In Progress in IoT Hub Portal Aug 2, 2022
hocinehacherouf added a commit that referenced this issue Aug 2, 2022
@hocinehacherouf
Migrate to mkdocs-material #990
7067c41
This was referenced Aug 2, 2022
Merged
Closed
Closed
@hocinehacherouf hocinehacherouf linked a pull request Aug 2, 2022 that will close this issue
Migrate documentation to mkdocs-material #990 #1010
Merged
9 tasks
hocinehacherouf added a commit that referenced this issue Aug 2, 2022
@hocinehacherouf
Add Iot Hub Portal logo #990
dd90192
@hocinehacherouf hocinehacherouf moved this from :construction: In Progress to :speech_balloon: Ready for Review in IoT Hub Portal Aug 2, 2022
kbeaugrand added a commit that referenced this issue Aug 3, 2022
@hocinehacherouf @kbeaugrand
Migrate documentation to mkdocs-material #990 (#1010)
bef66c1 
* Migrate to mkdocs-material #990

* Add /home/gitpod/.local/bin to PATH

* Add Iot Hub Portal logo #990

Co-authored-by: Kevin BEAUGRAND <9513635+kbeaugrand@users.noreply.github.com>
@hocinehacherouf hocinehacherouf moved this from :speech_balloon: Ready for Review to :rocket: Ready in IoT Hub Portal Aug 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hocinehacherouf hocinehacherouf

Labels
enhancement New feature or request
Projects
IoT Hub Portal
Status: 🚀 Ready
Milestone
S34
Development

Successfully merging a pull request may close this issue.

Migrate documentation to mkdocs-material #990 CGI-FR/IoT-Hub-Portal
2 participants
@kbeaugrand @hocinehacherouf