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

Update Documentation #394

Open
bsieber-mozilla opened this issue Feb 8, 2023 · 2 comments
Open

Update Documentation #394

bsieber-mozilla opened this issue Feb 8, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@bsieber-mozilla
Copy link
Contributor

          This looks sound.

There are other bits of the README that can be slightly inaccurate like:

  • The system sets the see_also field of the Bugzilla bug with the URL to the Jira issue: this is now a possible step instead of a systematic behavior
  • some missing comma in the allow_private parameter description
  • In the **Parameters** section, the default values are not specified consistently
  • Missing new line before ### Available Steps

Originally posted by @leplatrem in #380 (review)

@bsieber-mozilla
Copy link
Contributor Author

#380 (comment)

>     The system sets the see_also field of the Bugzilla bug with the URL to the Jira issue: this is now a possible step instead of a systematic behavior

@leplatrem if the setting of the `see_also` is optional, how are we planning to "link" bugs instead of making dupes each time? 

_It is my understanding that the see_also is the only connection to the downstream link_

>     - some missing comma in the allow_private parameter description
>     - In the **Parameters** section, the default values are not specified consistently
>     - Missing new line before ### Available Steps

I'll take a look to update these as well--thanks for the callouts

@bsieber-mozilla bsieber-mozilla added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 8, 2023
@leplatrem leplatrem added the good first issue Good for newcomers label Feb 23, 2023
@AshitaSingamsetty
Copy link
Contributor

I will work on this and submit a PR later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants