Skip to content

Commit

Permalink
Delete legacy workflow documentation and associated automation (#32)
Browse files Browse the repository at this point in the history
  • Loading branch information
eecavanna committed Nov 18, 2024
1 parent ad015d0 commit c5681ee
Show file tree
Hide file tree
Showing 37 changed files with 0 additions and 1,749 deletions.
44 changes: 0 additions & 44 deletions .github/workflows/compile-legacy-workflow-documentation.yml

This file was deleted.

5 changes: 0 additions & 5 deletions .github/workflows/deploy-to-gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@ jobs:
compile-legacy-nmdc-documentation:
name: Compile legacy NMDC documentation
uses: ./.github/workflows/compile-legacy-nmdc-documentation.yml
compile-legacy-workflow-documentation:
name: Compile legacy workflow documentation
uses: ./.github/workflows/compile-legacy-workflow-documentation.yml
fetch-and-compile-nmdc-runtime-documentation:
name: Fetch and compile NMDC Runtime documentation
uses: ./.github/workflows/fetch-and-compile-nmdc-runtime-documentation.yml
Expand All @@ -33,7 +30,6 @@ jobs:
# Reference: https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idneeds
needs:
- compile-legacy-nmdc-documentation
- compile-legacy-workflow-documentation
- fetch-and-compile-nmdc-runtime-documentation
- fetch-and-compile-mag-workflow-documentation
runs-on: ubuntu-latest
Expand All @@ -51,7 +47,6 @@ jobs:
ls -R artifacts
mkdir -p _build/html _build/html/legacy _build/html/workflows
cp -R artifacts/legacy-nmdc-documentation-as-html _build/html/legacy/nmdc-documentation
cp -R artifacts/legacy-workflow-documentation-as-html _build/html/legacy/workflow-documentation
cp -R artifacts/nmdc-runtime-documentation-as-html _build/html/nmdc-runtime-documentation
cp -R artifacts/mag-workflow-documentation-as-html _build/html/workflows/mag-workflow-documentation
cp content/index.html _build/html/index.html
Expand Down
29 changes: 0 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ This repository contains the content that we compile into our
* [Legacy content](#legacy-content)
* [NMDC documentation](#nmdc-documentation)
* [Omissions](#omissions)
* [Workflow documentation](#workflow-documentation)
* [Omissions](#omissions-1)
* [Code](#code)
* [Repository-level configuration files and documentation](#repository-level-configuration-files-and-documentation)
* [GitHub Actions](#github-actions)
Expand Down Expand Up @@ -83,33 +81,6 @@ git clone https://github.com/microbiomedata/NMDC_documentation.git /tmp/NMDC_doc
git diff --stat /tmp/NMDC_documentation/docs ./legacy/nmdc-documentation/src
```

#### Workflow documentation

Most of the files in the `legacy/workflow-documentation` directory are files that we copied from
[commit `40b5a313`](https://github.com/microbiomedata/workflow_documentation/commit/40b5a313db29eefae896fa1cfd98530324e5c91a)
in the [workflow_documentation](https://github.com/microbiomedata/workflow_documentation) repository.
That was the latest commit on the `main` branch as of August 28, 2024.
This documentation is implemented within the [Sphinx](https://www.sphinx-doc.org) documentation framework.

In addition to the files we copied, the directory also contains some files that are _exclusive_ to this repository;
e.g., `Dockerfile` and `.gitignore`.

##### Omissions

When copying the aforementioned files from the `workflow_documentation` repository, we _omitted_ files that were used
to fetch content from even higher upstream; i.e. from individual workflow repositories.

You can compare the `legacy/workflow-documentation/src` directory with the corresponding directory in the
upstream repository, by following these steps:

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

# Use Git to compare the corresponding directories.
git diff --stat /tmp/workflow_documentation/docs ./legacy/workflow-documentation/src
```

### Code

> [!NOTE]
Expand Down
1 change: 0 additions & 1 deletion content/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ <h2>Workflow documentation</h2>
<h2>Legacy documentation</h2>
<ul>
<li><a href="legacy/nmdc-documentation/index.html">legacy/nmdc-documentation</a></li>
<li><a href="legacy/workflow-documentation/index.html">legacy/workflow-documentation</a></li>
</ul>
</body>
</html>
12 changes: 0 additions & 12 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,13 @@ services:
volumes:
- ./legacy/nmdc-documentation:/app

legacy-workflow-documentation:
# Use the container image built from `legacy/workflow-documentation/Dockerfile`.
build:
context: legacy/workflow-documentation
dockerfile: Dockerfile
ports:
- "50001:8000"
volumes:
- ./legacy/workflow-documentation:/app

main-website:
image: nginx # Docs: https://hub.docker.com/_/nginx
depends_on:
- legacy-nmdc-documentation
- legacy-workflow-documentation
restart: unless-stopped
ports:
- "5000:80"
volumes:
- ./content:/usr/share/nginx/html
- ./legacy/nmdc-documentation/_build/html:/usr/share/nginx/html/legacy/nmdc-documentation
- ./legacy/workflow-documentation/_build/html:/usr/share/nginx/html/legacy/workflow-documentation
2 changes: 0 additions & 2 deletions legacy/workflow-documentation/.gitignore

This file was deleted.

21 changes: 0 additions & 21 deletions legacy/workflow-documentation/Dockerfile

This file was deleted.

1 change: 0 additions & 1 deletion legacy/workflow-documentation/requirements.txt

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
176 changes: 0 additions & 176 deletions legacy/workflow-documentation/src/chapters/1_RQC_index.rst

This file was deleted.

Loading

0 comments on commit c5681ee

Please sign in to comment.