diff --git a/.github/workflows/mdbook.yml b/.github/workflows/mdbook.yml index 4743c9a..e177caf 100644 --- a/.github/workflows/mdbook.yml +++ b/.github/workflows/mdbook.yml @@ -30,6 +30,8 @@ jobs: runs-on: ubuntu-latest env: MDBOOK_VERSION: 0.4.21 + SITEMAP_GEN_VERSION: 0.2.0 + PUBLISH_DOMAIN: component-model.bytecodealliance.org steps: - uses: actions/checkout@v3 - name: Install mdBook @@ -37,11 +39,17 @@ jobs: curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh rustup update cargo install --version ${MDBOOK_VERSION} mdbook + cargo install --version ${SITEMAP_GEN_VERSION} mdbook-sitemap-generator - name: Setup Pages id: pages uses: actions/configure-pages@v3 - name: Build with mdBook run: mdbook build component-model + - name: Generate sitemap + run: | + cd component-model + mdbook-sitemap-generator -d ${PUBLISH_DOMAIN} -o book/sitemap.xml + cd .. - name: Upload artifact uses: actions/upload-pages-artifact@v2 with: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1581371..586f059 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,13 +47,3 @@ Don't forget to remove the changes in `book.toml` before you commit! You can click the Fork button in the upper-right area of the screen to create a copy of this repository in your GitHub account. This copy is called a fork. Make any changes you want in your fork, and when you are ready to submit those changes, go to your fork and create a new pull request to let us know about it. Everyone is welcome to submit a pull request! Once your pull request is created, we'll try to get to reviewing it or responding to it in at most a few days. As the owner of the pull request, it is your responsibility to modify your pull request to address the feedback that has been provided to you by the reviewer. - -### Adding New Pages - -If you add a new page to the site, please note that the `sitemap.xml` will need to be updated to include that new page. The sitemap can be updated using the following proceedure: - -```bash -cargo install mdbook-sitemap-generator -cd component-docs -mdbook-sitemap-generator -d component-model.bytecodealliance.org -o sitemap.xml -``` diff --git a/component-model/src/sitemap.xml b/component-model/src/sitemap.xml deleted file mode 100644 index c0565a3..0000000 --- a/component-model/src/sitemap.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - https://component-model.bytecodealliance.org - 1.0 - - - https://component-model.bytecodealliance.org/design/components.html - 1.0 - - - https://component-model.bytecodealliance.org/design/why-component-model.html - 1.0 - - - https://component-model.bytecodealliance.org/design/canonical-abi.html - 1.0 - - - https://component-model.bytecodealliance.org/design/interfaces.html - 1.0 - - - https://component-model.bytecodealliance.org/design/packages.html - 1.0 - - - https://component-model.bytecodealliance.org/design/worlds.html - 1.0 - - - https://component-model.bytecodealliance.org/language-support/python.html - 1.0 - - - https://component-model.bytecodealliance.org/language-support/rust.html - 1.0 - - - https://component-model.bytecodealliance.org/language-support/javascript.html - 1.0 - - - https://component-model.bytecodealliance.org/introduction.html - 1.0 - - - https://component-model.bytecodealliance.org/tutorial.html - 1.0 - - - https://component-model.bytecodealliance.org/creating-and-consuming.html - 1.0 - - - https://component-model.bytecodealliance.org/implementations/wasmtime.html - 1.0 - - - https://component-model.bytecodealliance.org/implementations/jco.html - 1.0 - - - https://component-model.bytecodealliance.org/language-support.html - 1.0 - - - https://component-model.bytecodealliance.org/creating-and-consuming/authoring.html - 1.0 - - - https://component-model.bytecodealliance.org/creating-and-consuming/composing.html - 1.0 - - - https://component-model.bytecodealliance.org/creating-and-consuming/running.html - 1.0 - - - https://component-model.bytecodealliance.org/creating-and-consuming/distributing.html - 1.0 - - - https://component-model.bytecodealliance.org/wit-overview.html - 1.0 - - \ No newline at end of file