canonical / maas.io

Site for maas.io
https://maas.io/
GNU Lesser General Public License v3.0
16 stars 42 forks source link

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

Closed sparkiegeek closed 1 year ago

sparkiegeek commented 1 year ago

Done

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

QA

Issue / Card

Screenshots

Before

image

After

image

webteam-app commented 1 year ago

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

codecov[bot] commented 1 year ago

Codecov Report

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

:exclamation: 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%) :arrow_down:

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%) :arrow_up:
webapp/openapi_parser.py 94.44% <100.00%> (+0.32%) :arrow_up:
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 commented 1 year ago

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?

petermakowski commented 1 year ago

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

petermakowski commented 1 year ago

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

sparkiegeek commented 1 year ago

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

bartaz commented 1 year ago

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