Some doc updates

NCEAS · Jul 14, 2021 · b8c3fb4 · b8c3fb4
1 parent 40722eb
commit b8c3fb4
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 23 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -4,49 +4,51 @@ This folder of the MetacatUI repository contains the documentation for MetacatUI
 - Installation instructions
 - Developer documentation for the MetacatUI application
 
-## Building the documentation website
-This directory is also built into a simple HTML website, using Jekyll, that is hosted on Github Pages. You can view the last published version of the Github site here: https://nceas.github.io/metacatui/
 
-To build a local version of the MetacatUI Github pages site, ensure you have a relatively recent 2.x release of [Ruby](https://www.ruby-lang.org/) (e.g., 2.7.2) installed and make sure [Bundler](https://bundler.io/) is installed:
+## Building Developer documentation
+MetacatUI uses [JSDoc](https://github.com/jsdoc/jsdoc) comments to provide inline documentation of classes, methods, and variables. A JSDoc documentation generator will collect all those comments and generate HTML webpages for easier reading and navigation.
 
-```
-gem install bundler
-```
+The MetacatUI git repository already contains these generated HTML pages in the `docs/docs` directory. However, if you have made changes to the MetacatUI code and documentation and want to update the HTML doc pages, you will need to run the JSDoc generator.
 
-Install the gems required to build the site with:
+To build a fresh version of the MetacatUI developer docs, ensure you have [Node](https://nodejs.org/) installed and, from the top level of the repository, install JSDoc and other dependencies with:
 
 ```
-bundle install
+npm install
 ```
 
-Then serve the Jekyll site from the `docs` directory:
+and then, to build the documentation, run:
 
 ```
-bundle exec jekyll serve
+npm run jsdoc
 ```
 
-[See the Github Pages documentation for additional help](https://help.github.com/en/enterprise/2.14/user/articles/setting-up-your-github-pages-site-locally-with-jekyll#step-4-build-your-local-jekyll-site)
+If you're still running the `bundle exec jekyll serve` command above, your updated documentation will be automatically available at http://localhost:4000/docs/.
 
-## Building Developer documentation
-MetacatUI uses [JSDoc](https://github.com/jsdoc/jsdoc) comments to provide inline documentation of classes, methods, and variables. A JSDoc documentation generator will collect all those comments and generate HTML webpages for easier reading and navigation.
+Once your changes to the JSDocs are merged into the `main` branch, they will go live on the Github pages site at https://nceas.github.io/metacatui/docs/index.html.
 
-The MetacatUI git repository already contains these generated HTML pages in the `docs/docs` directory. However, if you have made changes to the MetacatUI code and documentation and want to update the HTML doc pages, you will need to run the JSDoc generator.
+## Building the documentation website
+This directory is also built into a simple HTML website, using Jekyll, that is hosted on Github Pages. You can view the last published version of the Github site here: https://nceas.github.io/metacatui/
 
-To build a fresh version of the MetacatUI developer docs, ensure you have [Node](https://nodejs.org/) installed and, from the top level of the repository, install JSDoc and other dependencies with:
+To build a local version of the MetacatUI Github pages site, ensure you have a relatively recent 2.x release of [Ruby](https://www.ruby-lang.org/) (e.g., 2.7.2) installed and make sure [Bundler](https://bundler.io/) is installed:
 
 ```
-npm install
+gem install bundler
 ```
 
-and then, to build the documentation, run:
+Install the gems required to build the site with:
 
 ```
-npm run jsdoc
+bundle install
 ```
 
-If you're still running the `bundle exec jekyll serve` command above, your updated documentation will be automatically available at http://localhost:4000/docs/.
+Then serve the Jekyll site from the `docs` directory:
+
+```
+bundle exec jekyll serve
+```
+
+[See the Github Pages documentation for additional help](https://help.github.com/en/enterprise/2.14/user/articles/setting-up-your-github-pages-site-locally-with-jekyll#step-4-build-your-local-jekyll-site)
 
-Once your changes to the JSDocs are merged into the `main` branch, they will go live on the Github pages site at https://nceas.github.io/metacatui/docs/index.html.
 
 ## Adding to this site
 Feel free to add pages to the MetacatUI docs website by adding markdown files to this `docs` directory. Use subdirectories

diff --git a/docs/_includes/homepage.html b/docs/_includes/homepage.html
@@ -1,5 +1,5 @@
 <section class="homepage">
-  <h1>MetacatUI is a web interface for Metacat data repositories.</h1>
+  <h1>MetacatUI is a web interface for scientific data repositories.</h1>
   <p>
     <a href="https://demo.nceas.ucsb.edu/">Try a live demo</a> |
     <a href="{{ site.url }}/screenshots/index.html">Screenshots</a>

diff --git a/docs/index.md b/docs/index.md
@@ -7,9 +7,9 @@ id: homepage
 {% include homepage.html %}
 
 ## About
-MetacatUI is a client-side web interface for querying Metacat servers and other servers that implement the DataONE REST API.  Currently, it is used as the basis for the [KNB Data Repository](http://knb.ecoinformatics.org), the [NSF Arctic Data Center](https://arcticdata.io/catalog/), the [DataONE federation](https://search.dataone.org), and other repositories.
+MetacatUI is a client-side web interface for Metacat science data repositories and other repository software that implement the DataONE REST API.  Currently, it is used as the basis for the [KNB Data Repository](http://knb.ecoinformatics.org), the [NSF Arctic Data Center](https://arcticdata.io/catalog/), the [DataONE federation](https://search.dataone.org), and other organizations.
 
-MetacatUI is an open source, community project.  We [welcome contributions](https://github.com/NCEAS/metacatui/blob/main/CONTRIBUTING.md) in many forms, including code, graphics, documentation, bug reports, testing, etc.  Use the [discussion list](https://github.com/NCEAS/metacatui/issues) to discuss these contributions with us.
+MetacatUI is an open source, community project.  We [welcome contributions](https://github.com/NCEAS/metacatui/blob/main/CONTRIBUTING.md) in many forms, including code, graphics, documentation, bug reports, testing, etc.  Use the [Github discussion list](https://github.com/NCEAS/metacatui/issues) to discuss these contributions with us.
 
 ## Related Projects