pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-06-14 16:51:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add a last change footer to the implementers guide (#6216)

Browse Source 
* Add a `last change` footer to the implementers guide

Some of the newcomers were noticing outdated pages in the implementer's guide.
This idea came up as a heuristic for how up-to-date an individual page is.

* Update `build-implementers-guide` CI job
This commit is contained in:
Marcin S
2022-11-08 08:06:02 -05:00
committed by GitHub
parent fb40925ebe
commit 6cc91f9187
4 changed files with 18 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
polkadot/roadmap/implementers-guide/README.md
+4 -3
View File
@@ -4,13 +4,14 @@ The implementers' guide is compiled from several source files with [`mdBook`](ht
## Hosted build ## Hosted build
This is avalible at https://paritytech.github.io/polkadot/book/ This is available [here](https://paritytech.github.io/polkadot/book/).
## Local build ## Local build
To view it locally from the repo root: To view it locally from the repo root:
Ensure graphviz is installed: Ensure graphviz is installed:
```sh ```sh
brew install graphviz # for macOS brew install graphviz # for macOS
sudo apt-get install graphviz # for Ubuntu/Debian sudo apt-get install graphviz # for Ubuntu/Debian
@@ -19,11 +20,11 @@ sudo apt-get install graphviz # for Ubuntu/Debian
Then install and build the book: Then install and build the book:
```sh ```sh
cargo install mdbook mdbook-linkcheck mdbook-graphviz mdbook-mermaid cargo install mdbook mdbook-linkcheck mdbook-graphviz mdbook-mermaid mdbook-last-changed
mdbook serve roadmap/implementers-guide mdbook serve roadmap/implementers-guide
open http://localhost:3000 open http://localhost:3000
``` ```
## Specification ## Specification
See also the Polkadot specificaton [hosted](https://spec.polkadot.network/), and it's [source](https://github.com/w3f/polkadot-spec)). See also the Polkadot specification [hosted](https://spec.polkadot.network/), and its [source](https://github.com/w3f/polkadot-spec).
polkadot/roadmap/implementers-guide/book.toml
+6
View File
@@ -9,8 +9,14 @@ title = "The Polkadot Parachain Host Implementers' Guide"
command = "mdbook-graphviz" command = "mdbook-graphviz"
[preprocessor.mermaid] [preprocessor.mermaid]
command = "mdbook-mermaid" command = "mdbook-mermaid"
[preprocessor.last-changed]
command = "mdbook-last-changed"
renderer = ["html"]
[output.html] [output.html]
additional-css = ["last-changed.css"]
additional-js = ["mermaid.min.js", "mermaid-init.js"] additional-js = ["mermaid.min.js", "mermaid-init.js"]
# Repository URL used in the last-changed link.
git-repository-url = "https://github.com/paritytech/polkadot"
[output.linkcheck] [output.linkcheck]
polkadot/roadmap/implementers-guide/last-changed.css
+7
View File
@@ -0,0 +1,7 @@
footer {
font-size: 0.8em;
text-align: center;
margin-top: 50px;
border-top: 1px solid black;
padding: 5px 0;
}
polkadot/scripts/ci/gitlab/pipeline/build.yml
+1 -1
View File
@@ -170,7 +170,7 @@ build-implementers-guide:
- .collect-artifacts-short - .collect-artifacts-short
script: script:
- apt-get -y update; apt-get install -y graphviz - apt-get -y update; apt-get install -y graphviz
- cargo install mdbook mdbook-mermaid mdbook-linkcheck mdbook-graphviz - cargo install mdbook mdbook-mermaid mdbook-linkcheck mdbook-graphviz mdbook-last-changed
- mdbook build ./roadmap/implementers-guide - mdbook build ./roadmap/implementers-guide
- mkdir -p artifacts - mkdir -p artifacts
- mv roadmap/implementers-guide/book artifacts/ - mv roadmap/implementers-guide/book artifacts/