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

Create airshipctl user guide documentation structure #280

Closed
eak13 opened this issue Jun 17, 2020 · 13 comments
Closed

Create airshipctl user guide documentation structure #280

eak13 opened this issue Jun 17, 2020 · 13 comments
Assignees
@SirishaGopigiri
Labels
5-Documentation Improvements or additions to documentation enhancement New feature or request priority/medium Default priority for items size l
Milestone
v2.1

Comments

@eak13
Copy link

eak13 commented Jun 17, 2020

Proposed change
Create a file/directory structure to to support more detailed user guide command documentation. This structure would be referenced within the code and will enable the documentation to be automatically generated at merge time.
@eak13 eak13 added the enhancement New feature or request label Jun 17, 2020
@eak13 eak13 mentioned this issue Jun 17, 2020
Closed
@jezogwza jezogwza added this to the v2.0 milestone Jun 24, 2020
@jezogwza jezogwza added the priority/medium Default priority for items label Oct 7, 2020
@eak13 eak13 added the 5-Documentation Improvements or additions to documentation label Dec 4, 2020
@drewwalters96 drewwalters96 removed their assignment Mar 8, 2021
@drewwalters96 drewwalters96 added the triage Needs evaluation by project members label Mar 8, 2021
@drewwalters96
Copy link
Contributor

The work on this has been dated, and we should reprioritize this on the flight plan call, especially since there is a team writing documentation now.

@SirishaGopigiri
Copy link
Contributor

Please assign this to me, thank you!

@eak13
Copy link
Author

eak13 commented Mar 10, 2021

@SirishaGopigiri all yours! This one is listed with a size xl currently but we moved away from using that. Once you assess, please let me know and I'll update the size label. Thanks!

@eak13 eak13 modified the milestones: v2.0, v2.1 Mar 10, 2021
@jezogwza jezogwza removed the triage Needs evaluation by project members label Mar 17, 2021
@SirishaGopigiri
Copy link
Contributor

@ak3216 Size would be 'L'. Thank you!

@eak13 eak13 added size l and removed size xl labels Mar 22, 2021
@airshipbot
Copy link

airshipbot commented Apr 1, 2021 •
edited
Loading

Related Change #784358

Subject: Create airshipctl cli user guide documentation structure
Link: https://review.opendev.org/c/airship/airshipctl/+/784358
Status: ABANDONED
Owner: Sirisha Gopigiri ([email protected])

Approvals

Code-Review
-2 Kostyantyn Kalynovskyi
Verified
+1 Zuul
+1 ATT Airship2.0 CI
Workflow
! None

Last Updated: 2021-05-05 04:39:57 CDT

@airshipbot
Copy link

airshipbot commented Apr 16, 2021 •
edited
Loading

Related Change #786629

Subject: Baremetal- updating cmd files for documentation
Link: https://review.opendev.org/c/airship/airshipctl/+/786629
Status: MERGED
Owner: Sirisha Gopigiri ([email protected])

Approvals

Code-Review
+2 Dmitry Ukov
+2 Kostyantyn Kalynovskyi
Verified
+1 ATT Airship2.0 CI
+2 Zuul
Workflow
+1 Dmitry Ukov

Last Updated: 2021-05-11 04:59:58 CDT

@airshipbot
Copy link

airshipbot commented Apr 19, 2021 •
edited
Loading

Related Change #786838

Subject: Zuul gate to check if the cli doc is generated
Link: https://review.opendev.org/c/airship/airshipctl/+/786838
Status: NEW
Owner: Sirisha Gopigiri ([email protected])

This change will close this issue when merged.

Approvals

Code-Review
+1 Bijaya Sharma
+1 Sujeet Chaudhary
Verified
+1 Zuul
+1 ATT Airship2.0 CI
Workflow
! None

Last Updated: 2021-05-26 03:59:01 CDT

@airshipbot
Copy link

airshipbot commented May 3, 2021 •
edited
Loading

Related Change #789250

Subject: Separate folders-Create airshipctl cli user guide documentation
Link: https://review.opendev.org/c/airship/airshipctl/+/789250
Status: NEW
Owner: Sirisha Gopigiri ([email protected])

Approvals

Code-Review
! None
Verified
-1 ATT Airship2.0 CI
+1 Zuul
Workflow
! None

Last Updated: 2021-05-26 03:39:00 CDT

@airshipbot
Copy link

airshipbot commented May 6, 2021 •
edited
Loading

Related Change #790003

Subject: Cluster- updating cmd files for documentation
Link: https://review.opendev.org/c/airship/airshipctl/+/790003
Status: MERGED
Owner: Sirisha Gopigiri ([email protected])

Approvals

Code-Review
+2 Dmitry Ukov
+2 Kostyantyn Kalynovskyi
Verified
+1 ATT Airship2.0 CI
+2 Zuul
Workflow
+1 Dmitry Ukov

Last Updated: 2021-05-11 04:59:57 CDT

@airshipbot
Copy link

airshipbot commented May 6, 2021 •
edited
Loading

Related Change #790020

Subject: Config- updating cmd files for documentation
Link: https://review.opendev.org/c/airship/airshipctl/+/790020
Status: NEW
Owner: Sirisha Gopigiri ([email protected])

Approvals

Code-Review
+2 Kostyantyn Kalynovskyi
+1 Brian Wickersham
+1 James Gu
+1 Lindsey Durway
Verified
+1 Zuul
+1 ATT Airship2.0 CI
Workflow
! None

Last Updated: 2021-05-26 10:39:00 CDT

@airshipbot
Copy link

airshipbot commented May 6, 2021 •
edited
Loading

Related Change #790023

Subject: Phase- updating cmd files for documentation
Link: https://review.opendev.org/c/airship/airshipctl/+/790023
Status: NEW
Owner: Sirisha Gopigiri ([email protected])

Approvals

Code-Review
+1 Lindsey Durway
+1 Bijaya Sharma
Verified
+1 Zuul
+1 ATT Airship2.0 CI
Workflow
! None

Last Updated: 2021-05-27 08:20:00 CDT

@airshipbot
Copy link

airshipbot commented May 6, 2021 •
edited
Loading

Related Change #790026

Subject: Plan,Secret- updating cmd files for documentation
Link: https://review.opendev.org/c/airship/airshipctl/+/790026
Status: NEW
Owner: Sirisha Gopigiri ([email protected])

Approvals

Code-Review
! None
Verified
+1 Zuul
+1 ATT Airship2.0 CI
Workflow
! None

Last Updated: 2021-05-27 05:59:01 CDT

@airshipbot
Copy link

airshipbot commented May 6, 2021 •
edited
Loading

Related Change #790033

Subject: Updating cmd files for documentation
Link: https://review.opendev.org/c/airship/airshipctl/+/790033
Status: NEW
Owner: Sirisha Gopigiri ([email protected])

Approvals

Code-Review
! None
Verified
-1 ATT Airship2.0 CI
+1 Zuul
Workflow
! None

Last Updated: 2021-05-28 01:59:57 CDT

airshipbot pushed a commit that referenced this issue May 11, 2021
@SirishaGopigiri
Baremetal- updating cmd files for documentation
ec3840a 
The description and examples are updated for the airshipctl
commands, which will be inturn used for generating documentation.
Please ignore the .md file changes in this PS. They are added for zuul
gates to pass. Here is the PS with generated documention
files https://review.opendev.org/c/airship/airshipctl/+/789250

Relates-To: #280
Change-Id: I323fa145b512e58cb878b117656c51bc39e76360
airshipbot pushed a commit that referenced this issue May 11, 2021
@SirishaGopigiri
Cluster- updating cmd files for documentation
d13d15f 
The description and examples are updated for the airshipctl
commands, which will be inturn used for generating documentation.
Please ignore the .md file changes in this PS. They are added for zuul
gates to pass. Here is the PS with generated documention
files https://review.opendev.org/c/airship/airshipctl/+/789250

Relates-To: #280
Change-Id: I7c088528842ff859f502d4484ff9a3847ebb1177
airshipbot pushed a commit that referenced this issue Jun 8, 2021
@SirishaGopigiri
Config- updating cmd files for documentation
3274b41 
The description and examples are updated for the airshipctl
commands, which will be inturn used for generating documentation.
Please ignore the .md file changes in this PS. They are added for zuul
gates to pass. Here is the PS with generated documention
files https://review.opendev.org/c/airship/airshipctl/+/789250

Relates-To: #280
Change-Id: If3ec175e2f582919296576a4bff6ae64871a7333
airshipbot pushed a commit that referenced this issue Jun 9, 2021
@SirishaGopigiri
Phase- updating cmd files for documentation
4c3140b 
The description and examples are updated for the airshipctl
commands, which will be inturn used for generating documentation.
Please ignore the .md file changes in this PS. They are added for zuul
gates to pass. Here is the PS with generated documention
files https://review.opendev.org/c/airship/airshipctl/+/789250

Relates-To: #280
Change-Id: I3587ad211f7d614b5cc6a162ca352ac54c3b90f0
airshipbot pushed a commit that referenced this issue Jun 10, 2021
@SirishaGopigiri
Plan,Secret- updating cmd files for documentation
14ef1f8 
The description and examples are updated for the airshipctl
commands, which will be inturn used for generating documentation.
Please ignore the .md file changes in this PS. They are added for zuul
gates to pass. Here is the PS with generated documention
files https://review.opendev.org/c/airship/airshipctl/+/789250

Relates-To: #280
Change-Id: I5d46bd361088cc1e4aff79a3009cd43a73ca1252
airshipbot pushed a commit that referenced this issue Jun 10, 2021
@SirishaGopigiri
Updating cmd files for documentation
21f015b 
This PS updates cmd related to root, completion, document and
version subcommands. It also updates minor details in other
subcommands.

The description and examples are updated for the airshipctl
commands, which will be inturn used for generating documentation.
Please ignore the .md file changes in this PS. They are added for zuul
gates to pass. Here is the PS with generated documention
files https://review.opendev.org/c/airship/airshipctl/+/789250

Relates-To: #280
Change-Id: I562c15c0d25b2e9731c0eb03854d1d348eb435f2
airshipbot pushed a commit that referenced this issue Jun 28, 2021
@SirishaGopigiri
Separate folders-Create airshipctl cli user guide documentation
4da8a54 
Current modified go code, generates RsT files for each airshipctl
cmd and places them in a folder specific to the airshipctl subcommand.
It also generates the index.rst file for the specific airshipctl
subcommand folders. These generated rst files are appropriate to sphinx,
so that they can be easliy rendered in docs.airshipit.org

Steps to render the document locally

	* Install sphinx: python3 -m pip install sphinx
        * Clone airshipctl: git clone https://github.com/airshipit/airshipctl.git
        * Download current PS: cd airshipctl; git fetch "https://review.opendev.org/airship/airshipctl" refs/changes/50/789250/2 && git checkout -b change-789250-1 FETCH_HEAD
	* Build sphinx html pages: cd docs/source; sphinx-build -b html . _build
	* Run local server: cd _build; python3 -m http.server
	* Open URL to access the page: http://localhost:8000/ navigate to commands section access the document

Relates-To: #280
Change-Id: Ifa1dafc7b296014cc826072ac2c52f4488421352
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@SirishaGopigiri SirishaGopigiri

Labels
5-Documentation Improvements or additions to documentation enhancement New feature or request priority/medium Default priority for items size l
Projects
None yet
Milestone
v2.1
Development

No branches or pull requests
5 participants
@eak13 @jezogwza @drewwalters96 @airshipbot @SirishaGopigiri