From c9ca7d99bc3acbe1b4b7cf64c3bbc5204f1e5d66 Mon Sep 17 00:00:00 2001 From: Sarah Schwartz <58856580+sarahschwartz@users.noreply.github.com> Date: Mon, 7 Aug 2023 15:39:19 -0600 Subject: [PATCH] feat: docs-hub CI test (#458) --- .github/workflows/docs.yml | 15 +++++++++++++ .github/workflows/markdown-lint.yml | 22 ------------------- docs/.gitignore | 2 +- docs/src/concepts/how_fuelup_works.md | 2 +- .../src/developer_guide/building_a_channel.md | 2 +- docs/src/overrides.md | 2 +- 6 files changed, 19 insertions(+), 26 deletions(-) create mode 100644 .github/workflows/docs.yml delete mode 100644 .github/workflows/markdown-lint.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 000000000..376f5c7ac --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,15 @@ +name: Docs + +on: + push: + branches: + - master + pull_request: + release: + types: [published] + +jobs: + test: + uses: FuelLabs/github-actions/.github/workflows/mdbook-docs.yml@master + with: + docs-src-path: 'docs/src' diff --git a/.github/workflows/markdown-lint.yml b/.github/workflows/markdown-lint.yml deleted file mode 100644 index b4aa28e93..000000000 --- a/.github/workflows/markdown-lint.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: Markdown Lint - -on: - push: - branches: - - master - pull_request: - release: - types: [published] - -jobs: - markdown-lint: - name: Markdown Lint - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - uses: actions/setup-node@v3 - with: - node-version: 18 - - run: | - npm install -g markdownlint-cli@0.32.1 - markdownlint --config .markdownlint.yaml '**/*.md' diff --git a/docs/.gitignore b/docs/.gitignore index 7585238ef..e9c072897 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1 +1 @@ -book +book \ No newline at end of file diff --git a/docs/src/concepts/how_fuelup_works.md b/docs/src/concepts/how_fuelup_works.md index 4965fab34..335ff3cee 100644 --- a/docs/src/concepts/how_fuelup_works.md +++ b/docs/src/concepts/how_fuelup_works.md @@ -39,7 +39,7 @@ turn executes the correct version of `forc` based on either an override file (`f or your currently active toolchain (in order of priority). -[fuelup-init]: ../installation/index.html#quickstart +[fuelup-init]: ../installation/index.md#quickstart [`rustup`]: https://github.com/rust-lang/rustup [`forc`]: https://fuellabs.github.io/sway/master/book/forc/index.html [`fuel-core`]: https://github.com/FuelLabs/fuel-core diff --git a/docs/src/developer_guide/building_a_channel.md b/docs/src/developer_guide/building_a_channel.md index c429ce3f8..d96c990e7 100644 --- a/docs/src/developer_guide/building_a_channel.md +++ b/docs/src/developer_guide/building_a_channel.md @@ -72,7 +72,7 @@ on this codebase. [Usage]: #usage [check versions workflow]: https://github.com/FuelLabs/fuelup/actions/workflows/index-versions.yml -[latest channel developer guide]: ../concepts/channels.html#understanding-the-latest-workflow +[latest channel developer guide]: ../concepts/channels.md#understanding-the-latest-workflow [test-toolchain-compatibility.yml]: https://github.com/FuelLabs/fuelup/blob/3abe817673184ac17a78b2a8965234813ac6d911/.github/workflows/test-toolchain-compatibility.yml#L174 [sway-nightly-binaries repository]: https://github.com/FuelLabs/sway-nightly-binaries [publish-nightly-channel.yml]: https://github.com/FuelLabs/fuelup/blob/3abe817673184ac17a78b2a8965234813ac6d911/.github/workflows/publish-nightly-channel.yml#L37 diff --git a/docs/src/overrides.md b/docs/src/overrides.md index 7ba085911..4f7528983 100644 --- a/docs/src/overrides.md +++ b/docs/src/overrides.md @@ -57,4 +57,4 @@ forc = "0.36.0" # in beta-3, forc is pinned to v0.37.3 [toolchain]: concepts/toolchains.md [distributed toolchains]: concepts/toolchains.md#toolchains -[`beta-3`]: concepts/channels#the-beta-3-channel +[`beta-3`]: concepts/channels.md#the-beta-3-channel