Autolab Documentation Improvement #1351
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Request for institution name in the bug template (#1285) * Modify mkdocs material theme to have tabs and use autolab red Co-authored-by: Victor Huang <victorhuangwq@gmail.com>
* Setup new page for installation unification * Split up ubuntu and osx installation pages * Modify installation docs structure * Change getting started to link to new installation page * Separate out commands into its own block * Change backtick code blocks to identation + colon style * Move Tango installation instructions to installation tab * Separate Tango deployment methods in docs * Improve wording on TLS/SSL, and link to Tango installation section after completing manual Autolab setup * Add minor change from SSL to TLS/SSL Co-authored-by: xtrkil <victorhuangwq@gmail.com>
* Setup new page for installation unification * Split up ubuntu and osx installation pages * Modify installation docs structure * Change getting started to link to new installation page * Separate out commands into its own block * Change backtick code blocks to identation + colon style * Move Tango installation instructions to installation tab * Separate Tango deployment methods in docs * Improve wording on TLS/SSL, and link to Tango installation section after completing manual Autolab setup * Add minor change from SSL to TLS/SSL * Separated overview from getting started; restructured index a little bit. * Restructure done; about to add in details for overview/introduction * Added picture for Autolab system. * Done with the initial draft for overview nad getting-started Co-authored-by: Fan Pu <zengfanpu@gmail.com> Co-authored-by: xtrkil <victorhuangwq@gmail.com>
* move initialize_user.sh from docker/ to bin/ * Update ubuntu and osx installation docs on creating initial root user step * Add init-user script
* Create new reference section * Add reference overview * Move vmms setup instructions from vmms api to tango overview * Updates wording * Updates wording on reference
* Fixed installation wrong link; did some reorganization on the part of Tango VMMS. * Replaced VMMS setup instruction.
* Improve Overview. * Adjust wording based on feedback.
* Make Reference section more catered to developers * Remove tango.md
* Reworded FAQ to Troubleshooting. Added pointers to troubleshooting sections. * Fixed wording.
* Ensure all links are valid and outgoing links open in new tab * Change outgoing link in tango.md to open in new tab
* updating docs with finalized wording * Documentation FAQ Refinement (#1348) * Reworded FAQ to Troubleshooting. Added pointers to troubleshooting sections. * Fixed wording. * Ensure all links are valid (#1349) * Ensure all links are valid and outgoing links open in new tab * Change outgoing link in tango.md to open in new tab * updating docs with finalized wording * fixing page linking Co-authored-by: xinyis991105 <54905587+xinyis991105@users.noreply.github.com> Co-authored-by: ashleyzhang <ashleyzhang@gmail.com>
* Add smtp settings in production.rb and documentation * Add instruction updates for development * Added description of where config files are at * fix syntax in mkdocs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR improves Autolab's documentation.
Motivation and Context
There's been complaint from within the team that Autolab's documentation is confusing and its aesthetic style is not exactly appreciable. This can discourage some potential new users. Since we are rolling out some new features and the new Docker Compose installation method is increasingly being used, we decided it's a good time to refine the documentation.
How Has This Been Tested?
mkdocs serve and visit local host.
The major changes involve:
Types of changes
Checklist:
Other issues / help required
If unsure, feel free to submit first and we'll help you along.