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

Improve help and doc #22 #23

Merged
merged 4 commits into from
Jan 16, 2023
Merged

Improve help and doc #22 #23

merged 4 commits into from
Jan 16, 2023

Conversation

pombredanne
Copy link
Contributor

This PR improves the intro documentation in the readme and the generated website help page.

Reference: #22

* Add overview section in README and in doc
* Use rst for README
* Remove copyright years from notices
* Use venv subdirectory for virtualenv

Signed-off-by: Philippe Ombredanne <[email protected]>
Signed-off-by: Philippe Ombredanne <[email protected]>
@@ -0,0 +1,126 @@
ScanCode LicenseDB
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mjherzog @DennisClark FYI... this parts would need your review and I could then propagate the edits to the help page too

* add new CLA license category
* update license category docs
* update reference to .LICENSE files correctly

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
Copy link
Contributor

@AyanSinhaMahapatra AyanSinhaMahapatra left a comment

Choose a reason for hiding this comment

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

I've pushed a commit with some minor changes:

  • update reference to .LICENSE files correctly
  • update README with the same and misc
  • add new CLA license category
  • update license category docs

Copy link

@DennisClark DennisClark left a comment

Choose a reason for hiding this comment

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

approved for Earth and beyond!

@pombredanne pombredanne merged commit 88c9010 into main Jan 16, 2023
@pombredanne pombredanne deleted the improve-help-and-doc branch January 16, 2023 11:56
@pombredanne
Copy link
Contributor Author

@AyanSinhaMahapatra ^ not sure how this meshes with your work in progress in ScanCode toolkit

@AyanSinhaMahapatra
Copy link
Contributor

@pombredanne I've had pushed a commit here and also updated this in #26 so it is all updated AFAIK

AyanSinhaMahapatra added a commit to aboutcode-org/scancode-toolkit that referenced this pull request Jan 17, 2023
@AyanSinhaMahapatra
Copy link
Contributor

No we missed the help.html which got replaced as we now build from scancode-toolkit. Opened a PR to fix this.

pombredanne added a commit to aboutcode-org/scancode-toolkit that referenced this pull request Jan 18, 2023
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.

3 participants