Skip to content

- adds documentation for issues automation - #3454

Merged
darrelmiller merged 4 commits into
OAI:mainfrom
baywet:feature/process-automation-documentation
Jan 2, 2024
Merged

darrelmiller merged 4 commits into
OAI:mainfrom
baywet:feature/process-automation-documentation

Conversation

@baywet

@baywet baywet commented Nov 17, 2023 •

Copy link
Copy Markdown
Member

fixes #3452

@lornajane lornajane left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for adding this information! I think it needs to go a lot further down the page since the automation (while excellent) is not key to our mission - perhaps between Transparency and Participation? Also is there a way we can condense the diagram, it's more than a whole screen tall for me and while it's a good representation of how the code works, I'm not sure this is the information that users need.

I'd be tempted to add a list of the labels and what they mean.

- adds labels descriptions

Signed-off-by: Vincent Biret <vibiret@microsoft.com>
@baywet

baywet commented Nov 22, 2023

Copy link
Copy Markdown
Member Author

just pushed some changes to implement the suggestions.
as for the flowchart, I'm not sure we can control mermaid diagram sizes besides with CSS which GitHub is not going to allow us to use on a markdown page. (but would if this ended up statically generated on a site).
maybe we could create a new markdown document for technical diagrams of automations or processes?

@baywet

baywet commented Dec 5, 2023

Copy link
Copy Markdown
Member Author

ping @lornajane

@lornajane

Copy link
Copy Markdown
Contributor

Thanks for moving the information to a better location in the document. I'm still not sure the mermaid diagram adds a lot for the amount of screen space it takes - the label descriptions are very good though!

@baywet

baywet commented Dec 6, 2023

Copy link
Copy Markdown
Member Author

@lornajane did you see my suggestion to adding a new page dedicated to the diagram?

@lornajane

Copy link
Copy Markdown
Contributor

I don't feel strongly about it - probably nobody would look at the diagram if we moved it, so maybe we can just remove it and see how we get on.

One question, when I reply to an issue that has "needs attention", do I manually remove that label when I do that?

@baywet

baywet commented Dec 13, 2023

Copy link
Copy Markdown
Member Author

To answer your question: yes when you reply you manually need to remove the "needs attention" label and add the "needs author feedback" one. We could also automate that, but I'd need a list of "experts" GitHub handle for the people who qualify for this automation (we don't want it to trigger for everyone).

Ok I'll remove the diagram, I found it's usually a good way to help people understand the logic of a workflow rather than lots of text.

@baywet

baywet commented Dec 13, 2023

Copy link
Copy Markdown
Member Author

updated. I also added information to when labels are added removed in their descriptions since we don't have the diagram anymore.

@darrelmiller
darrelmiller merged commit ecc4e50 into OAI:main Jan 2, 2024
@baywet
baywet deleted the feature/process-automation-documentation branch January 31, 2024 13:30
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.

Update DEVELOPMENT.md to explain labels and processes

3 participants