imhicihu/documentation-migration-readthedocs

A way to automatize our produced inner tutorials and documentation alongside the time. Up to now is a way of second branch (read solution) to get automated updates. One caveat: this repo must fix the "proxy server barrier" that we actually face.

RATIONALE

What is this repository for?

• Quick summary
  • A way to automatize our produced inner tutorials and documentation alongside the time. Up to now is a way of second branch (a.k.a solution) to get automated updates. One caveat: this repo must fix the proxy server barrier that we actually face.
  • ReadtheDocs is a free and open source hosting solution for online documentation.
    

How do I get set up?

• Summary of set up
  • create an account in ReadtheDocs
  • create an account in Bitbucket
  • create an account in GitHub
• Configuration
  • Actually, in processing instance
• Dependencies
  • a stable internet connection (a must condition)
  • a browser
  • our provided URL to browse the documentation
• Database configuration
  • All the documentation will be under a hood of one URL, courtesy by ReadtheDocs.
• How to run tests
  • No needed.
• Deployment instructions
  • Just browse the docs.

Related repositories

• Some repositories linked with this project:
  • Automatize digital actions
  • One Page website

Changelog

• Please check the Commits section for the current status

Who do I talk to?

• Repo owner or admin
  • Contact: imhicihu at gmail dot com

Code of Conduct

• Please, check our Code of Conduct

Legal

• All trademarks are the property of their respective owners.

License

• The content of this project itself is licensed under the MIT license