Merge pull request #8 from TidbitSoftware/main

Added badges; updated notes on repo structure and how to make changes

Author: TidbitSoftware

docs/README.md

@@ -1,12 +1,12 @@
 # ISSM Documentation
 Repository for generating online and PDF documentation for ISSM and storing publications based on ISSM.
 
-The [generated documentation] is a [Jekyll] site that uses a customized version of the [Just the Docs] theme and is built and published on [GitHub Pages].
+The [generated documentation](https://issmteam.github.io/ISSM-Documentation/) is a [Jekyll] site that uses a customized version of the [Just the Docs] theme and is built and published on [GitHub Pages].
 
 ## Making Changes to the Documentation
 If you have write access to this repository, you can make and commit changes from a copy of the repository or make changes to pages directly through the GitHub interface. Alternatively, all users may fork this repository and submit pull requests with proposed changes.
 
-It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub
+It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub.
 
 ### Previewing Changes Locally
 Assuming [Jekyll] and [Bundler] are installed on your computer:
@@ -19,8 +19,25 @@ Assuming [Jekyll] and [Bundler] are installed on your computer:
 
     The built site is stored in the directory `_site`.
 
-[generated documentation]: https://issmteam.github.io/ISSM-Documentation/
+## Structure
+Each page in the [front end of the documentation](https://issmteam.github.io/ISSM-Documentation/) has a corresponding Markdown file (`.md`) in the appropriate subdirectory of `docs/`. For example,
+````
+https://issmteam.github.io/ISSM-Documentation/getting-started/model-class
+````
+corresponds to,
+````
+docs/getting-started/model-class/index.md
+````
+A subdirectory may contain the default file (`index.md`) as well as additional sibling files. In these cases, the `index` file is just that: an index of the other files in the subdirectory (e.g. `docs/troubleshooting/index.md`).
+
+### Publications
+The 'Publications' page and its corresponding content files and their structure in the repo work differently. The important thing to know is that if you want to add a new publication to the front end page, you can do so by adding a DOI to the appropriate file in `docs/publications/doi`, which are named according to the year that the corresponding articles were published. On commit, the entire 'Publications' page will be regenerated.
+
+For more info, see `docs/publications/README`.
+
+<!--- Reference-style Links --->
 [Jekyll]: https://jekyllrb.com
 [Just the Docs]: https://just-the-docs.github.io/just-the-docs/
 [GitHub Pages]: https://docs.github.com/en/pages
 [Bundler]: https://bundler.io
+

docs/index.md

@@ -18,6 +18,8 @@ Please feel free to let us know how this documentation could be improved. We als
 ----
 <h2>Build Status</h2>
 ![Ubuntu - Basic](https://github.com/ISSMteam/ISSM/actions/workflows/ubuntu-basic.yml/badge.svg)
+[![Ubuntu Python](https://github.com/ISSMteam/ISSM/actions/workflows/ubuntu-python.yml/badge.svg)](https://github.com/ISSMteam/ISSM/actions/workflows/ubuntu-python.yml)
+[![Ubuntu CodiPack](https://github.com/ISSMteam/ISSM/actions/workflows/ubuntu-codipack.yml/badge.svg)](https://github.com/ISSMteam/ISSM/actions/workflows/ubuntu-codipack.yml)
 
 There are more regression tests on <a href="https://ross.ics.uci.edu/jenkins/view/All/" target="_blank">ISSM's Jenkins server</a>.
 

docs/installation/linux.md

@@ -202,4 +202,3 @@ make install
 
 You are now ready to 
 <a href="../getting-started" target="_top">get started with ISSM</a>!
-

docs/installation/macos.md

@@ -199,4 +199,3 @@ make install
 
 You are now ready to 
 <a href="../getting-started" target="_top">get started with ISSM</a>!
-

docs/installation/windows.md

@@ -273,4 +273,3 @@ Sources:
 
 - <a href="https://www.msys2.org/wiki/Setting-up-SSHd" target="_blank">MSYS2 'Setting up SSHd' webpage</a>
 - <a href="https://gist.github.com/samhocevar/00eec26d9e9988d080ac" target="_blank">Sam Hocevar's GitHub Gist page on setting up SSHd under MSYS2</a>
-