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.

Sign up for GitHub

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

Jump to bottom

Create DeltaCode documentation on ReadTheDocs #133

Closed
mjherzog opened this issue Mar 11, 2020 · 6 comments · Fixed by #168
Closed

Create DeltaCode documentation on ReadTheDocs #133

mjherzog opened this issue Mar 11, 2020 · 6 comments · Fixed by #168
Assignees
@chinyeungli
Labels
documentation GSOC Project/issues to be done during the GSOC Time frame help wanted must have
Projects
GSOC 2021 Deltacode

Comments

@mjherzog
Copy link
Member

The primary DeltaCode documentation is currently at the top of the AboutCode website on ReadtheDocs (RTD). It should be moved to its own RTD website. This task will also:

  • Include cross-checking it with the Wiki documentation and then removing the Wiki pages
  • Versioning the DeltaCode RTD website in sync with the code.
@ankit2001
Copy link

Do u want a separate blog for documentation ??

@mjherzog
Copy link
Member Author

mjherzog commented Mar 12, 2020 •
edited

Our goal here is to move the DeltaCode documentation from https://aboutcode.readthedocs.io/en/latest/deltacode/index.html to https://readthedocs.org/projects/deltacode/.
This will also require moving the corresponding file from https://github.com/nexB/aboutcode/tree/master/docs/source/deltacode to https://github.com/nexB/deltacode/tree/develop/docs.

@ankit2001
Copy link

okk thanks @mjherzog

@ankit2001 ankit2001 mentioned this issue Mar 14, 2020
Closed
@Pratikrocks Pratikrocks added this to Create Read The Docs support and improve the documentation in GSOC 2021 Deltacode Jun 16, 2021
@Pratikrocks Pratikrocks added the GSOC Project/issues to be done during the GSOC Time frame label Jun 24, 2021
@AyanSinhaMahapatra AyanSinhaMahapatra moved this from Create Read The Docs support and improve the documentation to ToDo in GSOC 2021 Deltacode Jul 19, 2021
@Pratikrocks Pratikrocks linked a pull request Jul 20, 2021 that will close this issue
Documentation changes #168
Merged
@AyanSinhaMahapatra AyanSinhaMahapatra moved this from ToDo to In Progress in GSOC 2021 Deltacode Jul 26, 2021
@AyanSinhaMahapatra
Copy link
Member

Also remove the old wikis and only link to the respective RTD pages for all of the wiki pages.

@mjherzog
Copy link
Member Author

Please move the existing RTD doc from AboutCode to DeltaCode on RTD.org. Ayan can assist you as needed.

@chinyeungli
Copy link
Contributor

Documentation is moved to https://deltacode.readthedocs.io/en/latest/deltacode/index.html#

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chinyeungli chinyeungli

Labels
documentation GSOC Project/issues to be done during the GSOC Time frame help wanted must have
Projects
GSOC 2021 Deltacode
In Progress
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Documentation changes Pratikrocks/deltacode
5 participants
@chinyeungli @mjherzog @AyanSinhaMahapatra @Pratikrocks @ankit2001