docs-site icon indicating copy to clipboard operation
docs-site copied to clipboard

Update the bill of materials for 1.8

Open Joe-Winchester opened this issue 5 years ago • 11 comments

Is your request for enhancement related to a problem? Please describe.

Maintaining the bill of materials is difficult to keep current as files are added and removed

Describe the solution you'd like

Remove this section from the documentation, unless there is a specific legal or otherwise reason we need to include it

Related doc pages

bill-of-materials.md

Additional context

Joe-Winchester avatar Feb 04 '20 12:02 Joe-Winchester

@nannanli and @BrandonJenkins14 - we're looking at the bill of materials which is out of date, and rather than fixing it we're wondering what the requirements are for shipping it and whether it's redundant. @nkocsis - do you recall if there is a reason we include the bill of materials on the public doc ?

Joe-Winchester avatar Feb 04 '20 12:02 Joe-Winchester

@MarkAckert might have an opinion/knowledge on this.

@jmertic

I am happy to remove it if it is not legally required or useful. I am only really aware of changes to it if someone pings me to let me know (not a reliable system obviously).

BrandonJenkins14 avatar Feb 04 '20 14:02 BrandonJenkins14

@swinslow - Can you comment here?

jmertic avatar Feb 04 '20 15:02 jmertic

I believe that both the bill of materials document and the third party library usage list are part of the certification that's provided when the Zowe binary releases are uploaded and published.

swinslow avatar Feb 04 '20 16:02 swinslow

Are we able to automate the generation of this file ?

nkocsis avatar Feb 04 '20 17:02 nkocsis

Are we able to automate the generation of this file ?

There is a research item open for this and is tagged as CI/CD https://github.com/zowe/zowe-install-packaging/issues/717

zFernand0 avatar Feb 05 '20 09:02 zFernand0

Any advice on how to proceed with the current 1.8 release? Note we also plan to republish Active Development doc concurrently (I made changes to that version of the BoM simply to add the new @latest compatible CLI plug-ins.

BrandonJenkins14 avatar Feb 05 '20 14:02 BrandonJenkins14

I've updated the titled to be "Update the BOM for 1.8" and I'll update the docs so they reflect the content of the 1.8 release. Going forward it'd be great if we could auto-generate but that can wait. Tks

Joe-Winchester avatar Feb 05 '20 14:02 Joe-Winchester

@Joe-Winchester @MarkAckert does this still need to be addressed for 1.8?

BrandonJenkins14 avatar Feb 11 '20 18:02 BrandonJenkins14

FYI I manually edited the CLI portion of BoM for 1.9 LTS release in doc-staging here https://github.com/zowe/docs-site/blob/docs-staging/docs/appendix/bill-of-materials.md#zowe-cli-package

BrandonJenkins14 avatar Feb 24 '20 18:02 BrandonJenkins14

Any updates on this? Or should this be closed?

jmertic avatar Dec 13 '22 12:12 jmertic

Closing as this is no longer applicable. Checked w/ @MarkAckert.

anaxceron avatar Mar 02 '23 20:03 anaxceron