Skip to content

gh pages setup#37

Draft
chantra wants to merge 2 commits intofl1ger:mainfrom
chantra:fix_md_formats
Draft

gh pages setup#37
chantra wants to merge 2 commits intofl1ger:mainfrom
chantra:fix_md_formats

Conversation

@chantra
Copy link
Contributor

@chantra chantra commented Jan 18, 2024

Setup GH pages using https://github.com/martinthomson/i-d-template tooling
Fixes #36

draft-dnsop-deleg-transport.md needed to be set to [`stand_alone: yes`](https://github.com/cabo/kramdown-rfc/#the-yaml-header) to be able to
run `make gh-pages`.

Abbreviation/title of dnssec and transport documents were updated to be able to differentiate them.

Finally, applying the fix from `make fix-lint` in order to be able to commit the changes.
@chantra
Copy link
Contributor Author

chantra commented Jan 18, 2024

Note that this is currently WIP as a bunch of existing files are being overridden by this change.

On top of dealing with GH pages generation, it will also take care of automating datatracker workflows.

Open to discussion.

@paulehoffman
Copy link
Contributor

I propose that we don't go down this path, given how fragile the whole setup is. Instead, we can go with a much cleaner repo that only has the .md files in it, and a makefile that uses the two IETF-supported tools. See https://github.com/paulehoffman/draft-rswg-rfc7990-updates for an example of this simplicity.

@chantra chantra marked this pull request as draft January 23, 2024 06:05
@chantra
Copy link
Contributor Author

chantra commented Jan 23, 2024

I propose that we don't go down this path, given how fragile the whole setup is.

I was under the impression that this was used by a fair amount of individual working on drafts, as well as a few WG.

I agree that a simple Makefile can be enough to get the job done, the i-d-template repo offer some features that makes contribution easier, leaving the .md as the base of the document, but taking care of the rest. I tried to highlight some of them in #36 .

Putting this PR back to draft cause I have no intent to get it merged as is, but rather use it for illustrative purpose.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Generate gh-pages

2 participants