Updated Documentation to DocGuide V1 Standards#715
Updated Documentation to DocGuide V1 Standards#715RogerJanusiak wants to merge 9 commits intomasterfrom
Conversation
…d the navigation bar.
for more information, see https://pre-commit.ci
…rontend into documentation_updates
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #715 +/- ##
=======================================
Coverage 98.35% 98.35%
=======================================
Files 30 30
Lines 2190 2190
=======================================
Hits 2154 2154
Misses 36 36
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
How do I test this? Is this now published somewhere? How do we ensure that when a doc update is made in this repo the docs on tryservicex.org are updated? |
|
@BenGalewsky You must build the docs locally. I will add instructions to this doc: https://github.com/ssl-hep/ServiceX_Website/blob/main/DocGuide.md But until then, you need to install all of the doc stuff into a venv. Navigate to the directory with the make files and source/. Then you can run this command On the auto updating the website, this feature cannot be added until all of the docs are moved to the new file structure. Then I will be able to edit the workflows to allow for this. But I think this step should be done first. Then I can build another PR to auto update the website. |
Using the DocGuide Standards that I created here:
https://github.com/ssl-hep/ServiceX_Website/blob/main/DocGuide.md
I updated the documentation to match. This includes:
First step towards closing issue #709 .