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

Issue 385 mkdocs doc #433

Merged
merged 2 commits into from
Jan 19, 2021
Merged

Issue 385 mkdocs doc #433

merged 2 commits into from
Jan 19, 2021

Conversation

srggrs
Copy link
Contributor

@srggrs srggrs commented Dec 10, 2020

This is the first version of the public website with documentation, tips and all the useful info for this pipeline.

Points:

  • You can check the actual website info on https://vast-survey.org/vast-pipeline/.
  • I linked some of the files inside the docs folder in this way:
    architecture
    changelog.md -> ../CHANGELOG.md
    code_of_conduct.md -> ../CODE_OF_CONDUCT.md
    developing
    img
    license.md -> ../LICENSE.txt
    quickstart
    README.md -> ../README.md
    theme
    usage
    so that when we modify the CHANGELOG and the others, the website will reflect those changes.
  • if you are wondering why the images and gif on the README are not rendering in the website, is because the repo is private, but they render on the branch in GitHub.

I was also wondering if we should re-organise the repo content by moving all the "app" code into vast_pipeline_app:

vast_pipeline_app
├── gulpfile.js
├── init-tools
├── manage.py
├── package.json
├── package-lock.json
├── scss
├── static
├── staticfiles
├── templates
├── vast_pipeline
└── webinterface

Close #385, close #324, close #22, close #355
Not sure about this #141 @ajstewart @marxide ?

@srggrs srggrs requested a review from ajstewart December 10, 2020 06:30
@srggrs srggrs added the documentation Improvements or additions to documentation label Dec 10, 2020
@srggrs srggrs requested a review from dliptai January 18, 2021 00:50
Copy link
Contributor

@ajstewart ajstewart left a comment

Choose a reason for hiding this comment

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

Mostly just text fixes.

@srggrs srggrs self-assigned this Jan 18, 2021
@srggrs srggrs requested a review from ajstewart January 18, 2021 02:24
Copy link
Contributor

@ajstewart ajstewart left a comment

Choose a reason for hiding this comment

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

Actually - I realised the changelog has not been updated.

@srggrs srggrs requested a review from ajstewart January 19, 2021 00:14
@srggrs
Copy link
Contributor Author

srggrs commented Jan 19, 2021

Actually - I realised the changelog has not been updated.

This is ready to be reviewed @ajstewart

@srggrs srggrs closed this Jan 19, 2021
@srggrs srggrs force-pushed the issue-385-mkdocs-doc branch from 8ee5453 to 4ab6f12 Compare January 19, 2021 02:50
@srggrs srggrs reopened this Jan 19, 2021
@ajstewart
Copy link
Contributor

ajstewart commented Jan 19, 2021

Has the CHANGELOG.md been updated with the changes this PR makes? I don't see any edits to it.

@srggrs
Copy link
Contributor Author

srggrs commented Jan 19, 2021

Has the CHANGELOG.md been updated with the changes this PR makes? I don't see any edits to it.

done

Copy link
Contributor

@ajstewart ajstewart left a comment

Choose a reason for hiding this comment

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

I'm happy for it to be merged.

@srggrs srggrs merged commit f5c9007 into master Jan 19, 2021
@srggrs srggrs deleted the issue-385-mkdocs-doc branch January 19, 2021 04:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
2 participants