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

Upgrade Discourse docs to v5, use revised index topic #772

Merged
merged 11 commits into from
Apr 21, 2023

Conversation

sparkiegeek
Copy link
Contributor

@sparkiegeek sparkiegeek commented Feb 14, 2023

Done

Bumped discourse to v5, point to new topic id with expandable sidenav

QA

  • Docs has expanding navigation
  • Tutorials are still listed and accessible
  • API docs are rendered

Issue / Card

Screenshots

Before

image

After

image

@webteam-app
Copy link

Demo starting at https://maas-io-772.demos.haus

@codecov
Copy link

codecov bot commented Mar 9, 2023

Codecov Report

Merging #772 (3504e17) into main (f885924) will decrease coverage by 3.91%.
The diff coverage is 69.38%.

❗ Current head 3504e17 differs from pull request most recent head 4f973b7. Consider uploading reports for the commit 4f973b7 to get more accurate results

@@            Coverage Diff             @@
##             main     #772      +/-   ##
==========================================
- Coverage   65.56%   61.65%   -3.91%     
==========================================
  Files           8        8              
  Lines         363      193     -170     
==========================================
- Hits          238      119     -119     
+ Misses        125       74      -51     
Flag Coverage Δ
python 61.65% <69.38%> (-3.91%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
webapp/views/tutorials.py 43.47% <43.47%> (ø)
webapp/app.py 85.10% <85.71%> (+15.24%) ⬆️
webapp/openapi_parser.py 94.44% <100.00%> (+0.32%) ⬆️
webapp/views/docs.py 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@evildmp
Copy link

evildmp commented Mar 21, 2023

I understand from @billwear that the MAAS documentation is now ready to be switched over to the new navigation. What needs to be done now for this to happen?

@sparkiegeek sparkiegeek force-pushed the demo-new-docs-v5 branch 4 times, most recently from cfccae1 to 30442ff Compare March 22, 2023 10:40
@sparkiegeek sparkiegeek changed the title Demo new docs v5 Upgrade Discourse docs to v5, use revised index topic Mar 22, 2023
requirements.txt Outdated Show resolved Hide resolved
templates/docs/document.html Outdated Show resolved Hide resolved
templates/docs/document.html Outdated Show resolved Hide resolved
@petermakowski
Copy link
Contributor

@sparkiegeek Fixed the layout styles and attached screenshots before and after.

@petermakowski
Copy link
Contributor

The API reference section needs some work, including that we no longer seem to display the auto-generated API docs.

@sparkiegeek
Copy link
Contributor Author

The API reference section needs some work, including that we no longer seem to display the auto-generated API docs.

Seems to be working now - suspect that was #777

@sparkiegeek sparkiegeek marked this pull request as ready for review April 4, 2023 17:34
@bartaz
Copy link
Member

bartaz commented Apr 6, 2023

Not sure why, but it seems that highlighting current page doesn't work. Regardless of where you go in navigation always top link is highlighted, navigation never expands on current page:

maas-docs-nav

@sparkiegeek sparkiegeek merged commit 4462606 into canonical:main Apr 21, 2023
@sparkiegeek sparkiegeek deleted the demo-new-docs-v5 branch April 21, 2023 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants