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

Create and update website man pages for CLI tools #3538

Closed
andrewdavidwong opened this Issue Feb 4, 2018 · 6 comments

Comments

Projects
None yet
2 participants
@andrewdavidwong
Member

andrewdavidwong commented Feb 4, 2018

Use the existing RST man pages in each respective tools' repo to render Markdown pages for the Qubes website. The results should be used to populate these pages:

Related issue: #3495

@andrewdavidwong andrewdavidwong added this to the Documentation/website milestone Feb 4, 2018

andrewdavidwong added a commit to QubesOS/qubes-doc that referenced this issue Feb 4, 2018

@awokd

This comment has been minimized.

Show comment
Hide comment
@awokd

awokd Feb 5, 2018

Would it be possible to update 3.2 pages as well? For example, I tried to link to qvm-grow-root but it's not there!

awokd commented Feb 5, 2018

Would it be possible to update 3.2 pages as well? For example, I tried to link to qvm-grow-root but it's not there!

@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong Feb 6, 2018

Member

Would it be possible to update 3.2 pages as well? For example, I tried to link to qvm-grow-root but it's not there!

Just to confirm: The problem is that we never had a page for qvm-grow-root on the website, not that it was there but subsequently disappeared, right?

Member

andrewdavidwong commented Feb 6, 2018

Would it be possible to update 3.2 pages as well? For example, I tried to link to qvm-grow-root but it's not there!

Just to confirm: The problem is that we never had a page for qvm-grow-root on the website, not that it was there but subsequently disappeared, right?

@andrewdavidwong andrewdavidwong changed the title from Create website man pages for 4.0 CLI tools to Create and update website man pages for CLI tools Feb 6, 2018

@awokd

This comment has been minimized.

Show comment
Hide comment
@awokd

awokd Feb 6, 2018

That is my understanding, yes. Believe this is a relatively new command for R3.2 (only, not 4.0) that never had a page on the website. There may be others; that's just one I wanted at the time.

awokd commented Feb 6, 2018

That is my understanding, yes. Believe this is a relatively new command for R3.2 (only, not 4.0) that never had a page on the website. There may be others; that's just one I wanted at the time.

andrewdavidwong added a commit to QubesOS/qubes-doc that referenced this issue Feb 12, 2018

@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong Feb 12, 2018

Member

@awokd: The Qubes 3.2 man pages should all be up-to-date now.

Member

andrewdavidwong commented Feb 12, 2018

@awokd: The Qubes 3.2 man pages should all be up-to-date now.

andrewdavidwong added a commit to QubesOS/qubesos.github.io that referenced this issue Feb 12, 2018

@awokd

This comment has been minimized.

Show comment
Hide comment
@awokd

awokd Feb 12, 2018

Nice, thank you @andrewdavidwong . So if I want to link to a specific version of qvm-whatever it's /doc/tools/3.2/dom0/qvm-whatever, while /doc/dom0-tools/qvm-whatever will always point to the latest version available?

awokd commented Feb 12, 2018

Nice, thank you @andrewdavidwong . So if I want to link to a specific version of qvm-whatever it's /doc/tools/3.2/dom0/qvm-whatever, while /doc/dom0-tools/qvm-whatever will always point to the latest version available?

@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong Feb 13, 2018

Member

No, /doc/dom0-tools/qvm-whatever redirects to the 3.2 version.

Member

andrewdavidwong commented Feb 13, 2018

No, /doc/dom0-tools/qvm-whatever redirects to the 3.2 version.

@awokd awokd referenced this issue Feb 15, 2018

Open

R4.0 User Documentation Tracking #3495

7 of 8 tasks complete

@andrewdavidwong andrewdavidwong self-assigned this Mar 18, 2018

andrewdavidwong added a commit to QubesOS/qubes-doc that referenced this issue Mar 18, 2018

andrewdavidwong added a commit to QubesOS/qubes-doc that referenced this issue Mar 18, 2018

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