Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.6 KB

README.md

File metadata and controls

35 lines (25 loc) · 1.6 KB

Home

The src directory

Most of the files in src are files that we copied from commit e0001a90 in the NMDC_documentation repository. That was the latest commit on the main branch as of August 28, 2024.

Omissions

When copying the aforementioned files from the NMDC_documentation repository, we omitted the following files (the paths shown here are relative to the root directory of that repository):

  • Schema element documentation in docs/reference/metadata
  • Schema-related images in docs/_static/images/reference/metadata
  • Schema in docs/_static/jsonschema

Instead of maintaining a local copy of the schema documentation here, we will redirect visitors to the standalone schema documentation.

Example: When someone visits /reference/metadata/xylene.html on this documentation website, they'll be automatically redirected to https://microbiomedata.github.io/nmdc-schema/xylene/. This redirection is configured in ./src/conf.py.

You can compare the .src/ directory with the corresponding directory in the upstream repository, by issuing these commands from the root directory of this repository:

# Clone the upstream repository onto your computer.
git clone https://github.com/microbiomedata/NMDC_documentation.git /tmp/NMDC_documentation

# Use Git to compare the corresponding directories. 
git diff --stat /tmp/NMDC_documentation/docs ./content/home/src