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.

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

Clarify details about sctool stop --disable #4062

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

GeoffMontee
Copy link


Please make sure that:

  • Code is split to commits that address a single change
  • Commit messages are informative
  • Commit titles have module prefix
  • Commit titles have issue nr. suffix

@Michal-Leszczynski
Copy link
Collaborator

Hi, thanks for the contribution!
We have a certain way of working with docs (the file you changed is autogenerated from other files), so I will change this PR (or reopen another one), so that this change is included properly into our codebase.

@GeoffMontee
Copy link
Author

Hi @Michal-Leszczynski ,

Thanks! I will try to watch for your changes, so I will know how to properly contribute to the docs next time.

@GeoffMontee
Copy link
Author

Hi @Michal-Leszczynski,

I used grep to find the other instance of the usage text, and I updated that text and amended the commit. Does this look right now?

@Michal-Leszczynski
Copy link
Collaborator

Hi @GeoffMontee, sorry for not responding for a long time.
I pushed small changes to your branch.

The general workflow for editing SM docs looks like that:

  1. If the change is about CLI sctool section, you need to find corresponding command docs under /pkg/command/<command_name>/res.yaml, edit it, and run make docs from repo root dir. This will re-generate all doc related files that are influenced by your change.
  2. If the change is about something else, you need to find corresponding doc file under /docs/source/<path_to_changed_docs>. This does not require any additional steps.

Anyway, thanks for the contribution and sorry again for leaving it for so long!

@GeoffMontee
Copy link
Author

Awesome, thank you for the information!

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