From ee3d8ac23e5b820c051c01822765fa312b1a5442 Mon Sep 17 00:00:00 2001 From: Steven Spencer Date: Tue, 16 Aug 2022 11:14:14 -0500 Subject: [PATCH] Minor changes * Move "Documentation Local Server" to it's own heading, rather than a sub-heading * fix incorrect capitalization of "documentation" * fix incorrect comma * remove confusing word "first" --- README.md | 7 +++---- docs/guides/contribute/local_docs.md | 4 ++-- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 522ec46d7b..ba1833b38e 100644 --- a/README.md +++ b/README.md @@ -105,18 +105,17 @@ Once all of the above is complete, you wait for confirmation that GitHub success If you are wanting to add more advanced elements in your document than just text (admonitions, tables, block quotes, etc.), [this document](https://docs.rockylinux.org/guides/contribute/rockydocs_formatting/) will help you get there. -### Documentation Local Server +## Documentation Local Server -The advantage of having Documentation running on a local server instance, is that you get to see how your changes will look when they are taken to the live system. You can build a complete documentation system on your local Linux workstation or VM. This procedure isn't for everyone, and is definitely a more advanced topic. There are two documents that will get you to a nice, complete, and protected documentation system using either Docker or LXD: +The advantage of having documentation running on a local server instance is that you get to see how your changes will look when they are taken to the live system. You can build a complete documentation system on your local Linux workstation or VM. This procedure isn't for everyone, and is definitely a more advanced topic. There are two documents that will get you to a nice, complete, and protected documentation system, using either Docker or LXD: * Docker Version [here](https://docs.rockylinux.org/guides/contribute/rockydocs_web_dev/) * LXD Version [here](https://docs.rockylinux.org/guides/contribute/mkdocs_lsyncd/) -There is a third method, that will get you up and running fast without either Docker or LXD, but read the caveats of this procedure carefully: +There is a third method that will get you up and running fast without either Docker or LXD, but read the caveats of this procedure carefully: * Fast Documentation System [here](https://docs.rockylinux.org/guides/contribute/local_docs/) - ## Keep Up With The Conversation If you haven't already, join the conversation on the [Rocky Linux Mattermost Server](https://chat.rockylinux.org/rocky-linux/) and stay up-to-date with what is going on. Join the [~Documentation channel](https://chat.rockylinux.org/rocky-linux/channels/documentation), or any other channel you are interested in. We'd be glad to have you with us! diff --git a/docs/guides/contribute/local_docs.md b/docs/guides/contribute/local_docs.md index 87a1c2d84e..5d0839445d 100644 --- a/docs/guides/contribute/local_docs.md +++ b/docs/guides/contribute/local_docs.md @@ -10,7 +10,7 @@ tags: # Introduction -You can build the documentation system locally without either Docker or LXD if you like. If you elect to use this procedure however, be aware that if you do a lot of Python coding or use Python locally, your safest bet is to create a Python Virtual Environment first [described here](https://docs.python.org/3/library/venv.html). This keeps all of your Python processes protected from each other, which is recommended. If you choose to use this procedure without the Python Virtual Environment, then just be aware that you are taking a certain amount of risk. +You can build the documentation system locally without either Docker or LXD if you like. If you elect to use this procedure however, be aware that if you do a lot of Python coding or use Python locally, your safest bet is to create a Python Virtual Environment [described here](https://docs.python.org/3/library/venv.html). This keeps all of your Python processes protected from each other, which is recommended. If you choose to use this procedure without the Python Virtual Environment, then just be aware that you are taking a certain amount of risk. ## Procedure @@ -46,4 +46,4 @@ mkdocs serve ## Conclusion -This provides a quick and simple way to run a local copy of docuumentation without Docker or LXD. If you choose this method, you should really setup a Python Virtual Environment to protect your other Python processes. +This provides a quick and simple way to run a local copy of documentation without Docker or LXD. If you choose this method, you should really setup a Python Virtual Environment to protect your other Python processes.