Skip to content

Conversation

@bsieber-mozilla
Copy link
Contributor

@bsieber-mozilla bsieber-mozilla commented Feb 1, 2023

Any other spots in the docs need updating @mozilla/jbi-reviewers ?

@bsieber-mozilla bsieber-mozilla requested a review from a team as a code owner February 1, 2023 01:38
@bsieber-mozilla bsieber-mozilla added the documentation Improvements or additions to documentation label Feb 1, 2023
Copy link
Contributor

@leplatrem leplatrem left a comment

Choose a reason for hiding this comment

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

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

@bsieber-mozilla
Copy link
Contributor Author

bsieber-mozilla commented Feb 2, 2023

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 merged commit 4fa5cec into main Feb 8, 2023
@bsieber-mozilla bsieber-mozilla deleted the docs-update branch February 8, 2023 20:55
@bsieber-mozilla
Copy link
Contributor Author

Merging this in; migrating other concerns to an issue to further discuss

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants