Where to put issues for "getting started with SPDX" documentation?
|
VM (Vicky) Brasseur
Howdy, team.
In last week’s Outreach call we discussed the lack of “getting started with SPDX” documentation, info that could take someone from Zero to SPDX. Currently it’s really hard for new people to show up and use/generate/understand SPDX, but we can (with time) fix that.
We decided that step one of this would be to start collecting ideas for newbie questions that’ll need answering, etc. We’ll do this in issues to make it easier to keep track of them.
The next question is…where should those issues go? The -spec repo isn’t a good fit for them, neither is outreach. Do we perhaps need a new -docs repo…? I don’t know, but it’s worth considering. Or is this premature optimization and we should just pick a repo to log the issues in and then move them later if needed?
So what do y’all think? Where should these issues go for now?
--V
-- VM (Vicky) Brasseur Director, Senior Strategy Advisor Open Source Program Office Wipro Limited ⏰ Time Zone: Pacific/West Coast US
Internal to Wipro |
|
|
|
William Bartholomew (CELA)
I would put them in the spdx-spec repository, and we can label them as docs. One of the reasons for this is it allows us to address issues holistically, for example, the right thing to do might be to clarify the spec, create samples, and write new docs.
I was experimenting with some new getting started documentation, you can see some examples here: https://iamwillbar.github.io/spdx-spec/v2.2.2/use-cases/sbom/ https://iamwillbar.github.io/spdx-spec/v2.2.2/use-cases/third-party/ https://iamwillbar.github.io/spdx-spec/v2.2.2/use-cases/vulnerability-management/
Regards,
William Bartholomew (he/him) – Let’s chat Principal Security Strategist Global Cybersecurity Policy – Microsoft
My working day may not be your working day. Please don’t feel obliged to reply to this e-mail outside of your normal working hours.
From: spdx@... <spdx@...> On Behalf Of
VM (Vicky) Brasseur via lists.spdx.org
Sent: Tuesday, June 21, 2022 10:48 AM To: spdx@... Subject: [EXTERNAL] [spdx] Where to put issues for "getting started with SPDX" documentation?
Howdy, team.
In last week’s Outreach call we discussed the lack of “getting started with SPDX” documentation, info that could take someone from Zero to SPDX. Currently it’s really hard for new people to show up and use/generate/understand SPDX, but we can (with time) fix that.
We decided that step one of this would be to start collecting ideas for newbie questions that’ll need answering, etc. We’ll do this in issues to make it easier to keep track of them.
The next question is…where should those issues go? The -spec repo isn’t a good fit for them, neither is outreach. Do we perhaps need a new -docs repo…? I don’t know, but it’s worth considering. Or is this premature optimization and we should just pick a repo to log the issues in and then move them later if needed?
So what do y’all think? Where should these issues go for now?
--V
-- VM (Vicky) Brasseur Director, Senior Strategy Advisor Open Source Program Office Wipro Limited ⏰ Time Zone: Pacific/West Coast US
'The information contained in this electronic message and any attachments to this message are intended for the exclusive use of the addressee(s) and may contain proprietary, confidential or privileged information. If you are not the intended recipient, you should not disseminate, distribute or copy this e-mail. Please notify the sender immediately and destroy all copies of this message and any attachments. WARNING: Computer viruses can be transmitted via email. The recipient should check this email and any attachments for the presence of viruses. The company accepts no liability for any damage caused by any virus transmitted by this email. www.wipro.com' Internal to Wipro |
|
|
|
Manbeck, Jack
Yes! I think this is a great idea. We’ve tried in the past to do this but could never get people “focused” on it. I agree its needed.
I vote to put it the list in GitHub. The wiki doesn’t seem to be used much anymore. I would create a repo for “getting started” collateral. Besides the questions we could add examples and other documents over time. The someone can just grab it when they want to get started,
We do have a FAQ: https://spdx.dev/faq/ that may have some good info as well if you have not seen it.
Jack Manbeck
From: spdx@... <spdx@...> On Behalf Of
VM (Vicky) Brasseur via lists.spdx.org
Sent: Tuesday, June 21, 2022 1:48 PM To: spdx@... Subject: [EXTERNAL] [spdx] Where to put issues for "getting started with SPDX" documentation?
Howdy, team.
In last week’s Outreach call we discussed the lack of “getting started with SPDX” documentation, info that could take someone from Zero to SPDX. Currently it’s really hard for new people to show up and use/generate/understand SPDX, but we can (with time) fix that.
We decided that step one of this would be to start collecting ideas for newbie questions that’ll need answering, etc. We’ll do this in issues to make it easier to keep track of them.
The next question is…where should those issues go? The -spec repo isn’t a good fit for them, neither is outreach. Do we perhaps need a new -docs repo…? I don’t know, but it’s worth considering. Or is this premature optimization and we should just pick a repo to log the issues in and then move them later if needed?
So what do y’all think? Where should these issues go for now?
--V
-- VM (Vicky) Brasseur Director, Senior Strategy Advisor Open Source Program Office Wipro Limited ⏰ Time Zone: Pacific/West Coast US
'The information contained in this electronic message and any attachments to this message are intended for the exclusive use of the addressee(s) and may contain proprietary, confidential or privileged information. If you are not the intended recipient, you should not disseminate, distribute or copy this e-mail. Please notify the sender immediately and destroy all copies of this message and any attachments. WARNING: Computer viruses can be transmitted via email. The recipient should check this email and any attachments for the presence of viruses. The company accepts no liability for any damage caused by any virus transmitted by this email. www.wipro.com' Internal to Wipro |
|
|
|
VM (Vicky) Brasseur
GitHub is a given, which is why we decided to start opening issues rather than just maintaining a file.
I’d prefer to have either a dedicated docs repo or a /docs folder in another appropriate repo, so we can do the docs in docusaurus or some other static site generator type thing.
Which leaves us back at my initial question: Which repo to put this stuff in? My vote is a new spdx/docs repo.
--V
-- VM (Vicky) Brasseur Director, Senior Strategy Advisor Open Source Program Office Wipro Limited ⏰ Time Zone: Pacific/West Coast US
From:
<spdx@...> on behalf of "Manbeck, Jack via lists.spdx.org" <j-manbeck2=ti.com@...>
CAUTION:This email is received from an external domain. Open the hyperlink(s) & attachment(s) with caution.
Yes! I think this is a great idea. We’ve tried in the past to do this but could never get people “focused” on it. I agree its needed.
I vote to put it the list in GitHub. The wiki doesn’t seem to be used much anymore. I would create a repo for “getting started” collateral. Besides the questions we could add examples and other documents over time. The someone can just grab it when they want to get started,
We do have a FAQ: https://spdx.dev/faq/ that may have some good info as well if you have not seen it.
Jack Manbeck
From: spdx@... <spdx@...>
On Behalf Of VM (Vicky) Brasseur via lists.spdx.org
Sent: Tuesday, June 21, 2022 1:48 PM To: spdx@... Subject: [EXTERNAL] [spdx] Where to put issues for "getting started with SPDX" documentation?
Howdy, team.
In last week’s Outreach call we discussed the lack of “getting started with SPDX” documentation, info that could take someone from Zero to SPDX. Currently it’s really hard for new people to show up and use/generate/understand SPDX, but we can (with time) fix that.
We decided that step one of this would be to start collecting ideas for newbie questions that’ll need answering, etc. We’ll do this in issues to make it easier to keep track of them.
The next question is…where should those issues go? The -spec repo isn’t a good fit for them, neither is outreach. Do we perhaps need a new -docs repo…? I don’t know, but it’s worth considering. Or is this premature optimization and we should just pick a repo to log the issues in and then move them later if needed?
So what do y’all think? Where should these issues go for now?
--V
-- VM (Vicky) Brasseur Director, Senior Strategy Advisor Open Source Program Office Wipro Limited ⏰ Time Zone: Pacific/West Coast US
'The information contained in this electronic message and any attachments to this message are intended for the exclusive use of the addressee(s) and may contain proprietary, confidential or privileged information. If you are not the intended recipient, you should not disseminate, distribute or copy this e-mail. Please notify the sender immediately and destroy all copies of this message and any attachments. WARNING: Computer viruses can be transmitted via email. The recipient should check this email and any attachments for the presence of viruses. The company accepts no liability for any damage caused by any virus transmitted by this email. www.wipro.com' Internal to Wipro
Internal to Wipro |
|
|
|
Alexios Zavras
May I propose something like github.com/spdx/help since “docs” covers a lot more things (even the specification itself). +1 on being a new, separate location.
-- zvr
From: spdx@... <spdx@...> On Behalf Of
VM (Vicky) Brasseur via lists.spdx.org
Sent: Thursday, 23 June, 2022 20:46 To: spdx@... Subject: Re: [spdx] Where to put issues for "getting started with SPDX" documentation?
GitHub is a given, which is why we decided to start opening issues rather than just maintaining a file.
I’d prefer to have either a dedicated docs repo or a /docs folder in another appropriate repo, so we can do the docs in docusaurus or some other static site generator type thing.
Which leaves us back at my initial question: Which repo to put this stuff in? My vote is a new spdx/docs repo.
--V
-- VM (Vicky) Brasseur Director, Senior Strategy Advisor Open Source Program Office Wipro Limited ⏰ Time Zone: Pacific/West Coast US
From:
<spdx@...> on behalf of "Manbeck, Jack via lists.spdx.org" <j-manbeck2=ti.com@...>
CAUTION:This email is received from an external domain. Open the hyperlink(s) & attachment(s) with caution.
Yes! I think this is a great idea. We’ve tried in the past to do this but could never get people “focused” on it. I agree its needed.
I vote to put it the list in GitHub. The wiki doesn’t seem to be used much anymore. I would create a repo for “getting started” collateral. Besides the questions we could add examples and other documents over time. The someone can just grab it when they want to get started,
We do have a FAQ: https://spdx.dev/faq/ that may have some good info as well if you have not seen it.
Jack Manbeck
Howdy, team.
In last week’s Outreach call we discussed the lack of “getting started with SPDX” documentation, info that could take someone from Zero to SPDX. Currently it’s really hard for new people to show up and use/generate/understand SPDX, but we can (with time) fix that.
We decided that step one of this would be to start collecting ideas for newbie questions that’ll need answering, etc. We’ll do this in issues to make it easier to keep track of them.
The next question is…where should those issues go? The -spec repo isn’t a good fit for them, neither is outreach. Do we perhaps need a new -docs repo…? I don’t know, but it’s worth considering. Or is this premature optimization and we should just pick a repo to log the issues in and then move them later if needed?
So what do y’all think? Where should these issues go for now?
--V
-- VM (Vicky) Brasseur Director, Senior Strategy Advisor Open Source Program Office Wipro Limited ⏰ Time Zone: Pacific/West Coast US
'The information contained in this electronic message and any attachments to this message are intended for the exclusive use of the addressee(s) and may contain proprietary, confidential or privileged information. If you are not the intended recipient, you should not disseminate, distribute or copy this e-mail. Please notify the sender immediately and destroy all copies of this message and any attachments. WARNING: Computer viruses can be transmitted via email. The recipient should check this email and any attachments for the presence of viruses. The company accepts no liability for any damage caused by any virus transmitted by this email. www.wipro.com' Internal to Wipro 'The information contained in this electronic message and any attachments to this message are intended for the exclusive use of the addressee(s) and may contain proprietary, confidential or privileged information. If you are not the intended recipient, you should not disseminate, distribute or copy this e-mail. Please notify the sender immediately and destroy all copies of this message and any attachments. WARNING: Computer viruses can be transmitted via email. The recipient should check this email and any attachments for the presence of viruses. The company accepts no liability for any damage caused by any virus transmitted by this email. www.wipro.com' Internal to Wipro Intel Deutschland GmbH |
|
|
|
Manbeck, Jack
I agree something like help or getting started as a repo name. That way someone can just grab all of the getting started collaterals that may get generated over time: documents, examples, etc.,.
Jack
From: spdx@... <spdx@...> On Behalf Of
Alexios Zavras
Sent: Friday, June 24, 2022 5:23 AM To: spdx@... Subject: [EXTERNAL] Re: [spdx] Where to put issues for "getting started with SPDX" documentation?
May I propose something like github.com/spdx/help since “docs” covers a lot more things (even the specification itself). +1 on being a new, separate location.
-- zvr
GitHub is a given, which is why we decided to start opening issues rather than just maintaining a file.
I’d prefer to have either a dedicated docs repo or a /docs folder in another appropriate repo, so we can do the docs in docusaurus or some other static site generator type thing.
Which leaves us back at my initial question: Which repo to put this stuff in? My vote is a new spdx/docs repo.
--V
-- VM (Vicky) Brasseur Director, Senior Strategy Advisor Open Source Program Office Wipro Limited ⏰ Time Zone: Pacific/West Coast US
From:
<spdx@...> on behalf of "Manbeck, Jack via lists.spdx.org" <j-manbeck2=ti.com@...>
CAUTION:This email is received from an external domain. Open the hyperlink(s) & attachment(s) with caution.
Yes! I think this is a great idea. We’ve tried in the past to do this but could never get people “focused” on it. I agree its needed.
I vote to put it the list in GitHub. The wiki doesn’t seem to be used much anymore. I would create a repo for “getting started” collateral. Besides the questions we could add examples and other documents over time. The someone can just grab it when they want to get started,
We do have a FAQ: https://spdx.dev/faq/ that may have some good info as well if you have not seen it.
Jack Manbeck
Howdy, team.
In last week’s Outreach call we discussed the lack of “getting started with SPDX” documentation, info that could take someone from Zero to SPDX. Currently it’s really hard for new people to show up and use/generate/understand SPDX, but we can (with time) fix that.
We decided that step one of this would be to start collecting ideas for newbie questions that’ll need answering, etc. We’ll do this in issues to make it easier to keep track of them.
The next question is…where should those issues go? The -spec repo isn’t a good fit for them, neither is outreach. Do we perhaps need a new -docs repo…? I don’t know, but it’s worth considering. Or is this premature optimization and we should just pick a repo to log the issues in and then move them later if needed?
So what do y’all think? Where should these issues go for now?
--V
-- VM (Vicky) Brasseur Director, Senior Strategy Advisor Open Source Program Office Wipro Limited ⏰ Time Zone: Pacific/West Coast US
'The information contained in this electronic message and any attachments to this message are intended for the exclusive use of the addressee(s) and may contain proprietary, confidential or privileged information. If you are not the intended recipient, you should not disseminate, distribute or copy this e-mail. Please notify the sender immediately and destroy all copies of this message and any attachments. WARNING: Computer viruses can be transmitted via email. The recipient should check this email and any attachments for the presence of viruses. The company accepts no liability for any damage caused by any virus transmitted by this email. www.wipro.com' Internal to Wipro 'The information contained in this electronic message and any attachments to this message are intended for the exclusive use of the addressee(s) and may contain proprietary, confidential or privileged information. If you are not the intended recipient, you should not disseminate, distribute or copy this e-mail. Please notify the sender immediately and destroy all copies of this message and any attachments. WARNING: Computer viruses can be transmitted via email. The recipient should check this email and any attachments for the presence of viruses. The company accepts no liability for any damage caused by any virus transmitted by this email. www.wipro.com' Internal to Wipro Intel Deutschland GmbH |
|
|
|
VM (Vicky) Brasseur
I lean strongly toward `docs` as the repo name. It’s a standard and expected name for a repo that contains any sort of documentation, so people will be able to find it in GitHub.
Yes, the spec officially qualifies as a document but that’s easy enough to link to rather than move (and it would make little sense to move it under a docs repo anyway).
--V
From:
<spdx@...> on behalf of "Manbeck, Jack via lists.spdx.org" <j-manbeck2=ti.com@...>
CAUTION:This email is received from an external domain. Open the hyperlink(s) & attachment(s) with caution.
I agree something like help or getting started as a repo name. That way someone can just grab all of the getting started collaterals that may get generated over time: documents, examples, etc.,.
Jack
From: spdx@... <spdx@...>
On Behalf Of Alexios Zavras
Sent: Friday, June 24, 2022 5:23 AM To: spdx@... Subject: [EXTERNAL] Re: [spdx] Where to put issues for "getting started with SPDX" documentation?
May I propose something like github.com/spdx/help since “docs” covers a lot more things (even the specification itself). +1 on being a new, separate location.
-- zvr
GitHub is a given, which is why we decided to start opening issues rather than just maintaining a file.
I’d prefer to have either a dedicated docs repo or a /docs folder in another appropriate repo, so we can do the docs in docusaurus or some other static site generator type thing.
Which leaves us back at my initial question: Which repo to put this stuff in? My vote is a new spdx/docs repo.
--V
-- VM (Vicky) Brasseur Director, Senior Strategy Advisor Open Source Program Office Wipro Limited ⏰ Time Zone: Pacific/West Coast US
From:
<spdx@...> on behalf of "Manbeck, Jack via lists.spdx.org" <j-manbeck2=ti.com@...>
CAUTION:This email is received from an external domain. Open the hyperlink(s) & attachment(s) with caution.
Yes! I think this is a great idea. We’ve tried in the past to do this but could never get people “focused” on it. I agree its needed.
I vote to put it the list in GitHub. The wiki doesn’t seem to be used much anymore. I would create a repo for “getting started” collateral. Besides the questions we could add examples and other documents over time. The someone can just grab it when they want to get started,
We do have a FAQ: https://spdx.dev/faq/ that may have some good info as well if you have not seen it.
Jack Manbeck
Howdy, team.
In last week’s Outreach call we discussed the lack of “getting started with SPDX” documentation, info that could take someone from Zero to SPDX. Currently it’s really hard for new people to show up and use/generate/understand SPDX, but we can (with time) fix that.
We decided that step one of this would be to start collecting ideas for newbie questions that’ll need answering, etc. We’ll do this in issues to make it easier to keep track of them.
The next question is…where should those issues go? The -spec repo isn’t a good fit for them, neither is outreach. Do we perhaps need a new -docs repo…? I don’t know, but it’s worth considering. Or is this premature optimization and we should just pick a repo to log the issues in and then move them later if needed?
So what do y’all think? Where should these issues go for now?
--V
-- VM (Vicky) Brasseur Director, Senior Strategy Advisor Open Source Program Office Wipro Limited ⏰ Time Zone: Pacific/West Coast US
'The information contained in this electronic message and any attachments to this message are intended for the exclusive use of the addressee(s) and may contain proprietary, confidential or privileged information. If you are not the intended recipient, you should not disseminate, distribute or copy this e-mail. Please notify the sender immediately and destroy all copies of this message and any attachments. WARNING: Computer viruses can be transmitted via email. The recipient should check this email and any attachments for the presence of viruses. The company accepts no liability for any damage caused by any virus transmitted by this email. www.wipro.com' Internal to Wipro 'The information contained in this electronic message and any attachments to this message are intended for the exclusive use of the addressee(s) and may contain proprietary, confidential or privileged information. If you are not the intended recipient, you should not disseminate, distribute or copy this e-mail. Please notify the sender immediately and destroy all copies of this message and any attachments. WARNING: Computer viruses can be transmitted via email. The recipient should check this email and any attachments for the presence of viruses. The company accepts no liability for any damage caused by any virus transmitted by this email. www.wipro.com' Internal to Wipro Intel Deutschland GmbH
Internal to Wipro |
|
|