Welcome to TechLadies AFA's Coder Diary
This repository is a little documentation about our learning-journey when creating the Asian Film Archive's submissions application as part of the TechLadies programme.
How to contribute to this diary
We are using MkDocs to create and organize this diary. Follow these steps to add entry:
- Clone this repo to your local folder:
git clone https://github.com/TechLadies/afa-diary.gitor if you already have a clone, pull the latest changes:git pull - Change your directory to afa-diary:
cd afa-diary - Create Virtualenv named mkdocs:
mkvirtualenv mkdocs - Install MkDocs and other requirements using pip:
pip install -r requirements.txt - At this point, you can preview your local MkDocs site by running
server command:
mkdocs server. You should see something like this and then use browser to go to http://localhost:8000
- Make your changes locally and use localhost to preview the changes.
Remember to add your page name and corresponding .md file to
mkdocs.yml - Stage the changed files:
git add . - Commit to git:
git commit -m "Your descriptive message" - Push to Github repo:
git push -u origin master