IEEE Hyderabad Section Website
Site Development Environment
- Install MakDocs (http://www.mkdocs.org/)
- Install Material Theme for MkDocs (https://github.com/squidfunk/mkdocs-material).
- Customize the fonts, colors etc.
Development Process
- Follow GitHub workflow.
- Note: You need to have at least one file in a directory to get pushed. So, please do not push empty directories.
Build
- Pull the GitHub Repository (https://github.com/ieeehyd-website/2018)
- Follow the MkDocs instructions
Deployment
- Upload the output HTML directory into Amazon S3 bucket.
Release Notes
- Every build should have a release notes.
Versioning
- The Git repository should be labelled at least weekly.
- IEEE-HYD-SITE-YYYY-MM.DD. is the format of the release numbering.
Backup
- All the release tarballs (simple clone the Git Repo and create a Tar / Zip file) should be backedup promptly.
Attributions
- MkDocs (http://www.mkdocs.org/)
- MkDocs+ (https://github.com/bwmarrin/MkDocsPlus)
- MkDocs Material Theme (https://github.com/squidfunk/mkdocs-material)
- GitHub (https://github.com/)