-
Notifications
You must be signed in to change notification settings - Fork 9.2k
Description
[NOTE: I'm filing this issue in this repo because it's about things that currently happen here.]
In today's call we rediscovered the OAI/community repository.
- It has a lot of useful information, but some of it is out of date, and there's significant overlap with things in this repository.
- It would be the ideal place to route user / implementor questions that are a huge percentage of the issues and discussions here in the spec repo (@lornajane kind of like our discussion of moving them to the learn repo, but even better because then we can just use learn issues for actual docs changes)
- It seems like a better home for our general governance and process work. Perhaps the
Processlabel can move over there, and we keepHousekeepinghere for the day-to-day repo/project specific stuff? (paging @earth2marsh from our Process vs Housekeeping discussion)
Note that @webron transferred OAI/community#5 over to that repo as a community question, so apparently we already thought about doing that part once.
Proposed workflow for user / implementor questions
Currently we have two places (issues and discussions in this repo) serving three purposes:
- open-ended discussions (ideal for discussions, but historically mostly in issues
- actionable tasks (ideal for issues, but sometimes end up in discussions where they're even less likely to get a response)
- community members asking for help (probably the largest usage of both issues and discussions)
This makes the @OAI/triage work complex because community member questions aren't necessarily related to spec development, but could lead to changes so we tend to keep them open indefinitely. But it's very hard to extract what changes are needed, if any, from long back-and-forths that are more help-desk-like than spec writing.
- When a user question issue or discussion is opened in any repo other than OAI/community, @OAI/triage immediately transfers it to OAI/community, before responding at all
- If something in OAI/community turns out to motivate a spec change, open a new issue (if the change is clear) or discussion (if it's a broad topic that needs more discussion) in this repo (or the appropriate SIG repo), and link to the OAI/commuity issue
- If something in OAI/community motivates documentation or examples on the Learn site, either open a new issue or move the issue over to OAI/learn.openapis.org
- I'd still argue for closing answered questions, but if we want that
We want a new issue for the spec (including SIGs) because it's often very challenging to extract the spec change requirements from Q&A conversations. For Learn site changes, sometimes you want a summary but sometimes the Q&A really illustrates what needs documenting, so I think we can be more flexible there.
If we do this, we should copy the "needs author response" / "no recent activity" issue automation over.
Overlaps that need to be de-duped or moved
- move README.md "Participation" section (link to new location)
- move TOB.md
- move GOVERNANCE.md
- update community SPECIAL_INTEREST_GROUPS.md and remove the one here
- maybe move some of DEVELOPMENT.md like "Participation" and "Community Roles"
- do we need CODE_OF_CONDUCT.md in each repo? It is also the only thing in OAI/.github because GitHub looks for certain things there (I have not checked whether they are all in sync)
- we could move the weekly meeting issues and workflow over there, but if that Thursday meeting stays focused primarily on OAS I'd probably keep it here. The community meeting can link to the meeting agendas for various repos/SIGs.
Metadata
Metadata
Labels
Type
Projects
Status