Technical Documentation Website

[smaranjitghose]

Requirements:

• Home Page:
  • Information about Project
  • Open Source :
    - Programs we are a part of: info about SLOP, SWOC,DWOC
    - Contribution Guide
    - Code of Conduct
    - License
  • Team
    - Project Maintainer
    - Project Contributor
• Getting Started:
  - Using this repo as a template on GitHub
  - Getting the source code locally
  - Model Integration
  - Updating Model Files
  - Updating the Image Classifier Script
  - Front End Changes
  - Home Page [ Of the app] -
  - Team Page
  - About Page
  - Firebase and more Pages!
  - Setup Firebase for the project
  - Store Configuration Files to reference Firebase Project
  - Setup Real time database for the project
  - Update the Contact Page
  - Setup Cloud Storage for the project -
  - Update the function to send images -
  - Remove Firebase(If not required)
• Deployment
  - Staging, Commiting and Pushing Changes to GitHub
  - Cloud Services:
  - Heroku
  - Google Cloud Services
  - Amazon Web Services -
  - Microsoft Azure
  - Digital Ocean
  - Linode
  - Python Everywhere

Directions:

• Package to be used: mkdocs
• Template to be followed: Material
• Branch to be pushed: gh-pages [the deploy], master[the docs/ directory inside which the documentation would be present] - Please gitignore everything under site/

References:

• Deploy, Relevant Source Code

NOTE:

• Please only take up the this issue once you are fully comfortable with using and hosting docs with mkdocs.
• This issue is not be done all at once but in various parts. Whenever you comment interested, just specify which part of the documentation you want to build
• If the information for the part is not available, please wait for it be available (like Guide for Digital Ocean), this issue has be worked upon in parallel with the others. Only take up tasks for which the information is updated
• The source code to a similar documentation is already given above, and feel free to use YouTube for learning

[raman08]

I would like to work on this issue

[smaranjitghose]

Any updates @raman08 ?

[raman08]

Yes, I have setup the environment and just arranging the files

[raman08]

Sir I have buid a basic site, but I have a doubt
Should I copy all the documentation to the docs/ folder or something else

[raman08]

Sir, I have made a sample navigation bar as per the above requirement. and placed the Guides folder inside the docs folder. ANd link all the available pages to their respective link

[raman08]

Should I pull the changes??

[smaranjitghose]

@raman08 Please follow the changes suggested in the PR