Add documentation links and update install related guides by AyanSinhaMahapatra · Pull Request #1851 · aboutcode-org/scancode-toolkit

AyanSinhaMahapatra · 2019-12-05T21:33:28Z

Signed-off-by: Ayan Sinha Mahapatra ayansmahapatra@gmail.com

Updates install page and README to promote Python 3.6. This fixes Promote Python 3.6 to primary platform (vs Python 2.7) #1874.
Updates README to link to ReadTheDocs. This fixes Update scancode-toolkit github pages with new documentation links #1849 and Documentation Inconsistencies/Improvements Tracker #1813 (partly)
Update install methods related Information in the README and on the docs, for better support and clarity. Discussion comments here.

Tasks

Reviewed contribution guidelines
PR is descriptively titled 📑 and links the original issue above 🔗
Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR
Run tests locally to check for errors.
Commits are in uniquely-named feature branch and has no merge conflicts 📁

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

AyanSinhaMahapatra · 2019-12-05T21:36:36Z

The README can be checked here.

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

codecov · 2020-01-24T00:38:26Z

Codecov Report

Merging #1851 into develop will decrease coverage by <.01%.
The diff coverage is 98.39%.

@@             Coverage Diff             @@
##           develop    #1851      +/-   ##
===========================================
- Coverage    78.97%   78.96%   -0.01%     
===========================================
  Files          131      131              
  Lines        16924    16924              
===========================================
- Hits         13365    13364       -1     
- Misses        3559     3560       +1

Impacted Files	Coverage Δ
src/textcode/strings.py	`63.1% <100%> (ø)`	⬆️
src/summarycode/plugin_consolidate.py	`94.21% <100%> (ø)`	⬆️
src/packagedcode/models.py	`93.05% <100%> (ø)`	⬆️
src/packagedcode/phpcomposer.py	`90.64% <94%> (ø)`	⬆️
src/packagedcode/npm.py	`90.02% <99.11%> (ø)`	⬆️
src/scancode/api.py	`94.9% <0%> (-0.64%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b0fbe1a...1f82690. Read the comment docs.

AyanSinhaMahapatra · 2020-01-24T10:32:00Z

@MaJuRG Thanks for your comments, they were essential! I've resolved all of them now. :)

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

AyanSinhaMahapatra · 2020-01-24T16:13:37Z

@MaJuRG That's done. You can check that out here.

steven-esser

@AyanSinhaMahapatra My mistake.

@pombredanne This looks good to me. Not sure if you want to have a look or not before merge, but ill leave it open for a little

pombredanne · 2020-01-24T17:24:33Z


 - As a **standalone command line tool**, ScanCode is **easy to install**, run
-  and embed in your CI/CD processing pipeline. It runs on **Windows, macOS and Linux**.
+  and embed in your CI/CD processing pipeline. It runs on **Windows, MacOS and Linux**.


macOS is the correct case from what I can see on Apple's website

Oops, will correct this.

pombredanne · 2020-01-24T17:25:06Z

 |Develop| |devel-cov|  | |devel-posix|   | |devel-win|  |
 +-------+--------------+-----------------+--------------+

+Documentation Build


How is this different from the documentation link below?

This one is the Documentation Build (RTD) status, like the code build status often displayed on README's. The ones below are just links. Check it out here

pombredanne · 2020-01-24T17:26:39Z

 ============

-Pre-requisites:
+There are 3 main ways you can `install ScanCode <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html>`_.


Would it make sense to move the bulk of this in an INSTALL.rst file instead? and only keep the simple happy installation path here?

@pombredanne could you elaborate.

Okay right. That would definitely be better IMHO, the README being smaller and more concise. Should I do that? In that case I'd only link to the installation documentation right?

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

pombredanne · 2020-01-29T15:23:34Z

Thank you ++... merging!

Fixes #1851

Add RTD documentation link in README.rst

245e4ab

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

AyanSinhaMahapatra mentioned this pull request Dec 5, 2019

Update scancode-toolkit github pages with new documentation links #1849

Closed

AyanSinhaMahapatra changed the title ~~Add documentation links in README~~ Add documentation links and update install related guides in README Dec 7, 2019

AyanSinhaMahapatra mentioned this pull request Dec 7, 2019

Add Final Improvements/Changes before Migrating aboutcode-org/aboutcode#33

Merged

AyanSinhaMahapatra changed the title ~~Add documentation links and update install related guides in README~~ Add documentation links and update install related guides Jan 18, 2020

AyanSinhaMahapatra added 4 commits January 24, 2020 04:31

Update README with Doc Links and Install Methods

79f068d

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

Update INSTALL page to recommend Python 3.6 and Restructure

cc01e48

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

Update Index page

b0fbe1a

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

Merge branch 'develop' into add-doc-link-to-readme

8745ca0

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

AyanSinhaMahapatra requested review from DennisClark and pombredanne January 23, 2020 23:14

AyanSinhaMahapatra mentioned this pull request Jan 23, 2020

Promote Python 3.6 to primary platform (vs Python 2.7) #1874

Closed

steven-esser suggested changes Jan 24, 2020

View reviewed changes

AyanSinhaMahapatra force-pushed the add-doc-link-to-readme branch from 5489295 to e847d3b Compare January 24, 2020 10:30

AyanSinhaMahapatra requested a review from steven-esser January 24, 2020 10:31

steven-esser suggested changes Jan 24, 2020

View reviewed changes

Comment thread docs/source/getting-started/install.rst

Add fixes

3d39090

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

AyanSinhaMahapatra force-pushed the add-doc-link-to-readme branch from e847d3b to 3d39090 Compare January 24, 2020 15:42

AyanSinhaMahapatra requested a review from steven-esser January 24, 2020 16:14

steven-esser approved these changes Jan 24, 2020

View reviewed changes

pombredanne reviewed Jan 24, 2020

View reviewed changes

AyanSinhaMahapatra requested a review from pombredanne January 24, 2020 18:26

AyanSinhaMahapatra added 2 commits January 28, 2020 16:26

Move Install guides from README.rst to INSTALL.rst

8fc64be

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

Fix links to Install and Doc contribute guides

1f82690

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

AyanSinhaMahapatra force-pushed the add-doc-link-to-readme branch from 4c3c68c to 1f82690 Compare January 28, 2020 12:07

pombredanne approved these changes Jan 29, 2020

View reviewed changes

pombredanne merged commit e1ad0f3 into aboutcode-org:develop Jan 29, 2020

pombredanne pushed a commit that referenced this pull request May 9, 2022

Java: do not lex whitespace as Label, do not lex "default" as Label

fc159c4

Fixes #1851

Uh oh!

Uh oh!

Conversation

AyanSinhaMahapatra commented Dec 5, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Tasks

Uh oh!

AyanSinhaMahapatra commented Dec 5, 2019

Uh oh!

codecov Bot commented Jan 24, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AyanSinhaMahapatra commented Jan 24, 2020

Uh oh!

Uh oh!

AyanSinhaMahapatra commented Jan 24, 2020

Uh oh!

steven-esser left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pombredanne commented Jan 29, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

AyanSinhaMahapatra commented Dec 5, 2019 •

edited

Loading

codecov Bot commented Jan 24, 2020 •

edited

Loading