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

Better document goals and purpose #12

Open
joshbressers opened this issue Aug 17, 2022 · 12 comments
Open

Better document goals and purpose #12

joshbressers opened this issue Aug 17, 2022 · 12 comments
Assignees
Labels
action documentation Improvements or additions to documentation needs owner

Comments

@joshbressers
Copy link
Contributor

joshbressers commented Aug 17, 2022

During the last meeting
it was pointed out that we don't have our goals and purpose clearly defined

I did some digging, and realized we do have goals and purpose. It's just not written down in a very consumable manner.

For example there are objectives and scope in the README
But they need to be better.

We have the mobilization plan that lays out much of this also
https://openssf.org/oss-security-mobilization-plan/
Look at page 44

The work we have put into progress is related to these, the people who helped craft these documents have failed to make the content consumable for new folks, which is what must be rectified.

The volunteers to start making this content consumable are
Vicky, Bunny, Randall, Sarah

@joshbressers joshbressers added documentation Improvements or additions to documentation action labels Aug 17, 2022
@lumjjb
Copy link

lumjjb commented Aug 19, 2022

I'd be happy to also help out with this if there's room to!

@joshbressers
Copy link
Contributor Author

Sounds awesome @lumjjb.

I would suggest you chat with Vicky to see what the plan is

@vmbrasseur
Copy link

There is no plan yet. Currently, I haven't had a chance even to read this issue before just now. I request someone else take on leading this, because I can't realistically do more than advise on it for the foreseeable future.

@joshbressers
Copy link
Contributor Author

@lumjjb Can you be convinced to take the lead on this one?

@lumjjb
Copy link

lumjjb commented Aug 25, 2022

maybe :)... i am going to be out next week till 7 September, I can pick it up then if someone hasn't already.

@joshbressers
Copy link
Contributor Author

I'll see if there's interest in the next meeting on Aug 30, if not, it's all yours :)

@vmbrasseur
Copy link

The work is starting over in a Google Doc.

We're starting by taking the text from the Mobilization Plan document and then refining it. Please edit/suggest/comment as you see fit.

@lumjjb
Copy link

lumjjb commented Oct 10, 2022

I've restructured the doc (changes tracked - but may be a bit messy so if folks find it easier, i can accept all the changes).

I've added some comments to suggest moving certain aspects to a separate document as well.

@joshbressers
Copy link
Contributor Author

I approved all your changes @lumjjb, this document is a lot easier to read now, thanks!

@stevespringett
Copy link

Looking at the goals and purpose, there is no mention of CycloneDX, is this meant to be format neutral or specific to SDPX?

@lumjjb
Copy link

lumjjb commented Nov 16, 2022

Should be format neutral. A lot of the requirement SPDX wording was from the original document published, i think we would want to have the ongoing cdx work that the group envisions working on in the doc as well or move the actual work items to another doc and leave this high-level.

@sjanevans
Copy link

Saw your request in slack. +1, @joshbressers Will the issue let you @ me now?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
action documentation Improvements or additions to documentation needs owner
Projects
None yet
Development

No branches or pull requests

5 participants