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

Create a registry of standard profiles as a .md file #140

Open
mbrush opened this issue May 28, 2024 · 3 comments
Open

Create a registry of standard profiles as a .md file #140

mbrush opened this issue May 28, 2024 · 3 comments
Assignees

Comments

@mbrush
Copy link
Contributor

mbrush commented May 28, 2024

Maybe not pressing at the moment, but consider creating a registry of standard profiles as a .md file

  • It would define a authoritative name, abbreviation for referencing the profile from other places - e.g. directory names file names (per Issue 139), or in_subset annotations on core-im content (per issue 142).
  • It could clearly defines scope of work, interested projects, etc.
  • If we want to maintain/update this file, we could also capture things like current status/maturity, projects implementing, links to related content/documentation

Note that the results of the surveys being sent out now (Spring 2024) can help seed the catalog, and inform its utility / development.

@rrfreimuth
Copy link

I think each profile should be a separate md file so that we can track changes to profiles more tightly. It might also be a good idea to apply the maturity model to each profile, which would give us a spectrum of states.

@larrybabb
Copy link
Contributor

larrybabb commented Jun 13, 2024

I think the title of this issue may overstate what is being asked. A Registry is a much more complex thing that a doc (.md file) that references the list of profiles, which is what I think is being suggested.

@mbrush I would consider rewording the heading on this issue so that it does not attract the wrong attention.

We will definitely have one schema and .md doc for each profile, but a dashboard of all the profiles will also be a useful doc to provide as a landing page when looking for the individual docs. This is definitely a good thing to do and can be done at any time.

@larrybabb
Copy link
Contributor

I created a single profiles_source.yaml file that will contain all the standard profiles. It should be relatively easy to craft an rst doc page for the spect that contains a list and pointer to each of the standard profiles. There are only a few so this is easy enough to manually manage until such time as it is worth building some type of automation.

If you agree @mbrush please consider closing this and adding a task for you and/or @javild to create a catalog.rst file for the spec.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

4 participants