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.

Sign up for GitHub

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

Jump to bottom

Automate updating the documents on crmsh.github.io #1374

Closed
nicholasyang2022 opened this issue Mar 27, 2024 · 0 comments
Closed

Automate updating the documents on crmsh.github.io #1374

nicholasyang2022 opened this issue Mar 27, 2024 · 0 comments

Comments

@nicholasyang2022
Copy link
Collaborator

The documents hosted on crmsh.github.io was last updated for crmsh-4.3.

Since crmsh-4.3, the document has been separated into 2 parts, one is in crmsh.8.adoc and another is from crm <subcommand> --help. The documents on crmsh.github.io is generated only from the former part.

We need to convert the output of crm <subcommand> --help into asciidoc and merge them into crmsh.8.adoc and setup automatic pipelines for updating the website.
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Mar 27, 2024
@nicholasyang2022
Dev: ui_context: make help subcommands to exit with 0 (ClusterLabs#1374)
a8e9120 
It is not a failure.
@nicholasyang2022 nicholasyang2022 mentioned this issue Mar 27, 2024
Merged
liangxin1300 added a commit that referenced this issue Mar 27, 2024
@liangxin1300
Merge pull request #1375 from nicholasyang2022/help-exit-with-zero
74a899f 
[crmsh-4.6] Dev: ui_context: make help subcommands to exit with 0 (#1374)
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 7, 2024
@nicholasyang2022
Dev: doc/toolchain: implement help2adoc (ClusterLabs#1374)
b3f71fc 
convert help text generated by python's argparse to asciidoc
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 7, 2024
@nicholasyang2022
Dev: doc/toolchain: implement adocxt (ClusterLabs#1374)
a054d58 
extracts sections needed to be generated from argparse help from tags in
crm.8.adoc and generates Makefile for building those adocs
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 7, 2024
@nicholasyang2022
Dev: doc/toolchain: add Containerfile (ClusterLabs#1374)
6b080df 
usage: `podman run --rm -ti -v <crmsh source root dir>:/opt/crmsh local/crmsh-doc-builder:latest`
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 7, 2024
@nicholasyang2022
Dev: doc/toolchain: implement generating include statement for asciid…
a37200b 
…oc (ClusterLabs#1374)

To generate a complete document, those sections generated from argparse
help needed to be included from crm.8.adoc
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 7, 2024
@nicholasyang2022
Dev: doc/toolchain: add asciidoctor (ClusterLabs#1374)
f94beaa 
`make all` now generates crm.8.html.
@nicholasyang2022 nicholasyang2022 mentioned this issue Apr 7, 2024
Merged
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 8, 2024
@nicholasyang2022
Dev: doc/toolchain: implement help2adoc (ClusterLabs#1374)
d06dad7 
convert help text generated by python's argparse to asciidoc
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 8, 2024
@nicholasyang2022
Dev: doc/toolchain: implement adocxt (ClusterLabs#1374)
313631f 
extracts sections needed to be generated from argparse help from tags in
crm.8.adoc and generates Makefile for building those adocs
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 8, 2024
@nicholasyang2022
Dev: doc/toolchain: add Containerfile (ClusterLabs#1374)
20f85e0 
usage: `podman run --rm -ti -v <crmsh source root dir>:/opt/crmsh local/crmsh-doc-builder:latest`
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 8, 2024
@nicholasyang2022
Dev: doc/toolchain: implement generating include statement for asciid…
17c7a2d 
…oc (ClusterLabs#1374)

To generate a complete document, those sections generated from argparse
help needed to be included from crm.8.adoc
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 8, 2024
@nicholasyang2022
Dev: doc/toolchain: add asciidoctor (ClusterLabs#1374)
497303f 
`make all` now generates crm.8.html.
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 10, 2024
@nicholasyang2022
Dev: doc/website-v1: adapt to python3 (ClusterLabs#1374)
f8afaa8
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 10, 2024
@nicholasyang2022
Dev: doc/toolchain: implement adocaio (ClusterLabs#1374)
321daa2 
a preprocessor for asciidoc inlcude directive to generate an all-in-one
adoc file
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 10, 2024
@nicholasyang2022
Dev: doc/website-v1: add man-4.6 (ClusterLabs#1374)
586c696
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 10, 2024
@nicholasyang2022
Dev: doc/toolchain: add asciidoc-py (ClusterLabs#1374)
ffbc44d
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 10, 2024
@nicholasyang2022
Dev: doc: add website target in Makefile (ClusterLabs#1374)
e294bb1
@nicholasyang2022 nicholasyang2022 mentioned this issue Apr 10, 2024
Merged
nicholasyang2022 added a commit that referenced this issue Apr 11, 2024
@nicholasyang2022
Merge pull request #1380 from nicholasyang2022/help2adoc
bfd7f06 
[crmsh-4.6] Dev: doc: implement help2adoc (#1374)
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc/website-v1: adapt to python3 (ClusterLabs#1374)
bf6c866
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc/toolchain: implement adocaio (ClusterLabs#1374)
7dd6a1e 
a preprocessor for asciidoc inlcude directive to generate an all-in-one
adoc file
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc/website-v1: add man-4.6 (ClusterLabs#1374)
321ee76
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc/toolchain: add asciidoc-py (ClusterLabs#1374)
e2f00ed
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc: add website target in Makefile (ClusterLabs#1374)
a5bcd49
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc: update howto build the website (ClusterLabs#1374)
f25a302
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc: update howto build the website (ClusterLabs#1374)
e813020
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc: update howto build the website (ClusterLabs#1374)
49f2030
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: Makefile: build all-in-one manpage crm.8 (ClusterLabs#1374)
f92942d 
and delegate document building to doc/Makefile.
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
fixup! Dev: Makefile: build all-in-one manpage crm.8 (ClusterLabs#1374)
2527ff0
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
fixup! Dev: Makefile: build all-in-one manpage crm.8 (ClusterLabs#1374)
2338635
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
fixup! Dev: Makefile: build all-in-one manpage crm.8 (ClusterLabs#1374)
39f195e
liangxin1300 added a commit that referenced this issue Apr 11, 2024
@liangxin1300
Merge pull request #1383 from nicholasyang2022/website-modernize
9c4bf6c 
[crmsh-4.6] Dev: doc/website-v1: add man-4.6 (#1374)
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc/toolchain: implement help2adoc (ClusterLabs#1374)
f912a8a 
convert help text generated by python's argparse to asciidoc
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc/toolchain: implement adocxt (ClusterLabs#1374)
5b8c334 
extracts sections needed to be generated from argparse help from tags in
crm.8.adoc and generates Makefile for building those adocs
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc/toolchain: add Containerfile (ClusterLabs#1374)
30b16d9 
usage: `podman run --rm -ti -v <crmsh source root dir>:/opt/crmsh local/crmsh-doc-builder:latest`
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc/toolchain: implement generating include statement for asciid…
23be357 
…oc (ClusterLabs#1374)

To generate a complete document, those sections generated from argparse
help needed to be included from crm.8.adoc
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc/toolchain: add asciidoctor (ClusterLabs#1374)
7bddf02 
`make all` now generates crm.8.html.
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc/website-v1: adapt to python3 (ClusterLabs#1374)
865636b
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc/toolchain: implement adocaio (ClusterLabs#1374)
fd76ec4 
a preprocessor for asciidoc inlcude directive to generate an all-in-one
adoc file
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc/website-v1: add man-4.6 (ClusterLabs#1374)
3d15463
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc/toolchain: add asciidoc-py (ClusterLabs#1374)
86f1982
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc: add website target in Makefile (ClusterLabs#1374)
4ab2e70
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: doc: update howto build the website (ClusterLabs#1374)
17772c0
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 11, 2024
@nicholasyang2022
Dev: Makefile: build all-in-one manpage crm.8 (ClusterLabs#1374)
7d4175d 
and delegate document building to doc/Makefile.
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 17, 2024
@nicholasyang2022
Dev: doc/toolchain: implement help2adoc (ClusterLabs#1374)
d490294 
convert help text generated by python's argparse to asciidoc
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 17, 2024
@nicholasyang2022
Dev: doc/toolchain: implement adocxt (ClusterLabs#1374)
f0d09e3 
extracts sections needed to be generated from argparse help from tags in
crm.8.adoc and generates Makefile for building those adocs
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 17, 2024
@nicholasyang2022
Dev: doc/toolchain: add Containerfile (ClusterLabs#1374)
d99ba93 
usage: `podman run --rm -ti -v <crmsh source root dir>:/opt/crmsh local/crmsh-doc-builder:latest`
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 17, 2024
@nicholasyang2022
Dev: doc/toolchain: implement generating include statement for asciid…
aff5e12 
…oc (ClusterLabs#1374)

To generate a complete document, those sections generated from argparse
help needed to be included from crm.8.adoc
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 17, 2024
@nicholasyang2022
Dev: doc/toolchain: add asciidoctor (ClusterLabs#1374)
16ffb53 
`make all` now generates crm.8.html.
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 17, 2024
@nicholasyang2022
Dev: doc/website-v1: adapt to python3 (ClusterLabs#1374)
5772b7c
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 17, 2024
@nicholasyang2022
Dev: doc/toolchain: implement adocaio (ClusterLabs#1374)
0d6f482 
a preprocessor for asciidoc inlcude directive to generate an all-in-one
adoc file
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 17, 2024
@nicholasyang2022
Dev: doc/website-v1: add man-4.6 (ClusterLabs#1374)
b6717c2
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 17, 2024
@nicholasyang2022
Dev: doc/toolchain: add asciidoc-py (ClusterLabs#1374)
8214419
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 17, 2024
@nicholasyang2022
Dev: doc: add website target in Makefile (ClusterLabs#1374)
af3a25a
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 17, 2024
@nicholasyang2022
Dev: doc: update howto build the website (ClusterLabs#1374)
156d591
liangxin1300 added a commit that referenced this issue Apr 22, 2024
@liangxin1300
Merge pull request #1385 from nicholasyang2022/help2text-and-website-…
8c7f5ae 
…port-master

Dev: doc: implement help2adoc (#1374)
nicholasyang2022 added a commit to nicholasyang2022/crmsh that referenced this issue Apr 28, 2024
@nicholasyang2022
Dev: ui_context: make help subcommands to exit with 0 (ClusterLabs#1374)
8baf8ab 
It is not a failure.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nicholasyang2022