Skip to content

Add build instruction and flow diagram - #971

Merged
goneall merged 7 commits into
spdx:development/v3.0.1from
bact:update-readme-build-flow
Jun 11, 2024
Merged

goneall merged 7 commits into
spdx:development/v3.0.1from
bact:update-readme-build-flow

Conversation

@bact

@bact bact commented Jun 10, 2024

Copy link
Copy Markdown
Collaborator

The intention of this PR is to allow more contributors to test the spec and spot issues early.
It will also allow more people to understand the build process which involved components across several spdx repos.

  • Add info on repo structure (which directory is for what purpose)
  • Update build instructions
    • Add a build flow diagram and instruction on using spdx-3-model, spdx-spec, and spec-parser together
    • Add info about MkDocs configuration
    • Add info about mike and GitHub workflow
  • Update info about development branch and repo

This is a rework of #946

Note: Once we are set on internationalization/localization, this will need to be updated again.

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
bact added 2 commits June 10, 2024 20:48
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@goneall goneall added this to the 3.0.1 milestone Jun 10, 2024
@bact

bact commented Jun 11, 2024

Copy link
Copy Markdown
Collaborator Author

@JPEWdev if you have time to review this again. (I have removed the ontology/ directory from the repo structure already).

@zvr

zvr commented Jun 11, 2024

Copy link
Copy Markdown
Member

I don't think build and website deployment instructions belong in the repo top-level README file, but maybe it's just me...

bact added 2 commits June 11, 2024 16:55
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>

@goneall goneall left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@goneall

goneall commented Jun 11, 2024

Copy link
Copy Markdown
Member

I don't think build and website deployment instructions belong in the repo top-level README file, but maybe it's just me...

We discussed on the tech and agreed that there is enough improvements here that we should go ahead and merge. We can decide later to split this out into a separate README and create a separate follow-on PR.

@goneall
goneall merged commit aac3e38 into spdx:development/v3.0.1 Jun 11, 2024
@bact
bact deleted the update-readme-build-flow branch June 15, 2024 21:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants