Skip to content

docs(fioctl): add examples of tags and apps #840

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

Merged
merged 4 commits into from
Jul 2, 2025

Conversation

StealthyCoder
Copy link
Member

@StealthyCoder StealthyCoder commented Jun 26, 2025

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

This PR adds some examples for the fioctl commands surrounding tags and apps, which have some specific logic, that was not previously documented other than in the code and maybe in the help of the command itself.

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

@StealthyCoder StealthyCoder force-pushed the docs/fioctl_commands branch 3 times, most recently from f62e3be to dd47ce8 Compare June 27, 2025 15:03
Copy link
Contributor

@kprosise kprosise left a comment

Choose a reason for hiding this comment

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

LGTM! Squash/fixup and then I would be happy to merge! Thanks for the additional fixes!

Signed-off-by: Eric Bode <eric.bode@foundries.io>
Signed-off-by: Eric Bode <eric.bode@foundries.io>
Signed-off-by: Eric Bode <eric.bode@foundries.io>
Signed-off-by: Eric Bode <eric.bode@foundries.io>
@StealthyCoder StealthyCoder force-pushed the docs/fioctl_commands branch from 814308b to fe3804b Compare July 2, 2025 10:02
@StealthyCoder
Copy link
Member Author

@kprosise I squashed them into 4, let me know if you think that is enough or you want them more compressed. 💪

@kprosise kprosise merged commit 9f301bf into foundriesio:main Jul 2, 2025
3 checks passed
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.

2 participants