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

Add build instruction and flow diagram #971

Merged
merged 7 commits into from
Jun 11, 2024

Conversation

bact
Copy link
Collaborator

@bact bact commented Jun 10, 2024

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
Copy link
Collaborator Author

bact commented Jun 11, 2024

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

@zvr
Copy link
Member

zvr commented Jun 11, 2024

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>
Copy link
Member

@goneall goneall left a comment

Choose a reason for hiding this comment

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

LGTM

@goneall
Copy link
Member

goneall commented Jun 11, 2024

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
3 checks passed
@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