Skip to content

Add documentation for OpenStack tools#319

Open
nicolasbock wants to merge 1 commit intomainfrom
SET-1468-write-stsstack-bundles-openstack-tools-content
Open

Add documentation for OpenStack tools#319
nicolasbock wants to merge 1 commit intomainfrom
SET-1468-write-stsstack-bundles-openstack-tools-content

Conversation

@nicolasbock
Copy link
Collaborator

Add documentation for OpenStack tools.

Signed-off-by: Nicolas Bock nicolas.bock@canonical.com

@nicolasbock nicolasbock marked this pull request as draft September 3, 2025 20:14
@nicolasbock nicolasbock force-pushed the SET-1468-write-stsstack-bundles-openstack-tools-content branch from fde35d7 to 4b1d54d Compare September 3, 2025 21:34
@brianphaley brianphaley self-assigned this Sep 4, 2025
@nicolasbock nicolasbock force-pushed the SET-1468-write-stsstack-bundles-openstack-tools-content branch 4 times, most recently from 7cae191 to 99a99db Compare September 8, 2025 16:43
@nicolasbock nicolasbock force-pushed the SET-1468-write-stsstack-bundles-openstack-tools-content branch from 99a99db to c227dc0 Compare September 22, 2025 17:27
@nicolasbock nicolasbock marked this pull request as ready for review September 22, 2025 17:28
Copy link
Collaborator Author

@nicolasbock nicolasbock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still missing some details on a few tools

@nicolasbock nicolasbock force-pushed the SET-1468-write-stsstack-bundles-openstack-tools-content branch 2 times, most recently from d532d8b to c51d1a7 Compare September 22, 2025 17:41
@nicolasbock nicolasbock requested a review from Copilot September 22, 2025 17:41
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds comprehensive documentation for OpenStack tools by creating a new tools documentation file and making minor formatting corrections to existing documentation files.

  • Creates detailed documentation for 20+ OpenStack utility scripts with descriptions and usage examples
  • Updates index files to include the new tools documentation section
  • Makes minor formatting improvements to existing documentation

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
docs/user-docs/openstack/tools.md New comprehensive documentation for OpenStack tools with examples
docs/user-docs/openstack/index.md Adds tools section to OpenStack documentation index
docs/user-docs/index.rst Adds generate-bundle.sh reference to main user docs
docs/user-docs/generate-bundle.rst Creates placeholder documentation for generate-bundle.sh
docs/user-docs/usage.rst Minor formatting change from double backticks to single backticks
docs/index.rst Formatting improvements with proper RST syntax for code references
docs/conf.py Adds commented configuration for MyST heading anchors
docs/.custom_wordlist.txt Adds technical terms to spell check wordlist
openstack/tools/float_all.sh Removes outdated comment about Newton client requirement

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@nicolasbock nicolasbock force-pushed the SET-1468-write-stsstack-bundles-openstack-tools-content branch 2 times, most recently from dfa7656 to c589149 Compare September 22, 2025 17:47
@nicolasbock nicolasbock requested a review from Copilot September 22, 2025 17:47
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@nicolasbock nicolasbock force-pushed the SET-1468-write-stsstack-bundles-openstack-tools-content branch from c589149 to 66ac3cb Compare September 22, 2025 17:51
@nicolasbock nicolasbock requested a review from Copilot September 22, 2025 17:51
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@nicolasbock nicolasbock force-pushed the SET-1468-write-stsstack-bundles-openstack-tools-content branch from 66ac3cb to 2eadac9 Compare September 22, 2025 17:52
@nicolasbock nicolasbock requested a review from Copilot September 22, 2025 17:53
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@nicolasbock nicolasbock force-pushed the SET-1468-write-stsstack-bundles-openstack-tools-content branch from 2eadac9 to 0ea3cd2 Compare September 22, 2025 17:55
@nicolasbock nicolasbock requested a review from Copilot September 22, 2025 17:55
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated no new comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@nicolasbock nicolasbock force-pushed the SET-1468-write-stsstack-bundles-openstack-tools-content branch 2 times, most recently from 7423489 to 05b8fa5 Compare September 22, 2025 18:16
@dosaboy
Copy link
Member

dosaboy commented Sep 24, 2025

Closes: https://warthogs.atlassian.net/browse/SET-1468
Signed-off-by: Nicolas Bock <nicolas.bock@canonical.com>
@nicolasbock nicolasbock force-pushed the SET-1468-write-stsstack-bundles-openstack-tools-content branch from 05b8fa5 to 7953532 Compare September 29, 2025 17:05
@@ -0,0 +1,29 @@
generate-bundle.sh
Copy link
Member

@dosaboy dosaboy Oct 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The information on this page already exists on the "Usage" page, rather than have a new page just for this script maybe better to update the existing info to cover anything extra added here and then reference the Usage page in your Tools page?

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.

4 participants