Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish implementers guide to Github pages #1614

Closed
wentelteefje opened this issue Sep 18, 2023 · 1 comment
Closed

Publish implementers guide to Github pages #1614

wentelteefje opened this issue Sep 18, 2023 · 1 comment
Assignees
Labels
T11-documentation This PR/Issue is related to documentation.

Comments

@wentelteefje
Copy link
Contributor

Since the monorepo merge we are still building the Implementer's guide here, but we no longer publish it to Github pages. This can be seen by comparing the current job to the old one; notice that the line copying the book

cp -r ./artifacts/book/ /tmp/

is missing from the current job.

There's an additional complication which prevents me from just submitting a PR myself, which is the use of index-tpl-crud for creating/updating the index.html file:

index-tpl-crud upsert ./index.html ${CI_COMMIT_REF_NAME}

I'm not really sure why we use this approach, when we're only ever building the docs from master. However, I think just mirroring the old index.html is the way to go here. I'm not sure but a manual change to the current index.html to account for the new book location might already do the trick:

<h1>Polkadot Implementers Guide</h1>
	<section><ul id="impl-guide" data-gh-repo="polkadot-sdk"><li><a href="/polkadot-sdk/book">link</a></li></ul></section>

Why this is needed: At the moment the book is still hosted in the archived Polkadot repository, which means it's read-only and will no longer be maintained over there. After this issue is resolved I will setup a redirect from the current location of the book paritytech.github.io/polkadot/book to paritytech.github.io/polkadot-sdk/book.

@wentelteefje wentelteefje added the T11-documentation This PR/Issue is related to documentation. label Sep 18, 2023
alvicsam added a commit that referenced this issue Sep 18, 2023
PR adds a job that publishes implementers guide

cc #1614
cc paritytech/ci_cd#879
@alvicsam alvicsam self-assigned this Sep 18, 2023
@alvicsam
Copy link
Contributor

The guide is published

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T11-documentation This PR/Issue is related to documentation.
Projects
Status: Done
Development

No branches or pull requests

2 participants