Members, this is your section!
It is in the member directory of the web framework files that you can access and easily update.
Don’t worry if you have never worked on a website before. We use a very popular and easy to use template system with markdown that you can gradually get familiar with and use a collaborative system that automatically builds and deploys when you signal you are ready.
Markdown, which is like a web page shortcut language, is used to write file contents. The basics can be mastered very quickly and it is very good at keeping writing organised with links, pictures and tables (if you want).
We have added two sample directories to member, member/profiles and member/showcase with further member directories. You can use these directories and files as a starting point but please do not use a directory or files someone may have started working on.
The workflow below appears confusing at first. However it is a well tried and trusted system that is very practical and after getting used to it you will fight like crazy against using any other way!
- Come into the club and talk to the president, Michael. Tell him what you are interested in and he will introduce you to the goals of the website and its guidelines. Don’t worry! The goals of the website are closely aligned with the goals of the club.
- If you still want to go ahead and the president agrees then obtain a free gitlab account from gitlab.com. All you need to provide is an email contact address and choose a username.
- Email the club with your gitlab username, stating the club has approved you as a club website developer. Even if you have never developed a website before we will still consider you a website developer. It is the intention that counts
- The club will add add your gitlab username to its list of website developers on gitlab and inform you.
Once you have access you will be able to access the web developer wiki. You need to enter in your gitlab login credentials. The wiki contains the most up to date version of the CMLC Web Developer Guidelines.
You can get help, raise issues, make suggestions, participate in discussions and communicate with other web developers as a group at the Issues Board for club website developers.
We want you to succeed. If you need help and you say nothing then we cannot help you. The issues board is where you will get help if you raise a new issue asking for help.
If the following instructions are too confusing then we can help show you at the club or you can ask to join a workshop. If you bring a laptop to a workshop then we can help you set up your laptop at the workshop.
- To view edits on a local webserver and optionally create blank template pages install the extended version of hugo. As mentioned, make sure hugo is added into the PATH environment variable.
- To fetch files and push changes with Windows install git
- Use any editor. An editor with convenient colour coding of markdown in Windows is Notepad++
Using software to create, edit and view your page
This is specific to Windows
- With Windows Explorer, choose any directory with right click, choose ‘Git Bash Here’ to open a console
Suppose username is your gitlab username and password is your gitlab password then in console enter
git clone https://username:email@example.com/cairnsmlc/website.git cd website hugo server
You only need to use the git clone command once. You can update the clone with command following in the website directory, as shown later
git pull --rebase
You now have access the club website served on your PC or laptop at address localhost:1313. You can stop the server wth Ctrl+C. Sometimes it is a good idea to stop the server and restart it again with ‘hugo server’ command
With Windows explorer and in the website directory right click again and choose ‘Git Bash Here’
Check you are in website directory with
Create a new username directory and index.md file in content/member/showcase directory. In the example below note the content directory is left out of the optional hugo command
hugo new member/showcase/username/index.md
Now edit the index.md file, including title, with your editor. Look at other files in website for examples or look at examples on the web using markdown. You can drop image files into your directory but please make sure they are no larger than 100Kb each and there are not too many. The website is not optimised for large size image files
View how the page will look at localhost:1313/member/showcase/username/
Updating the website with your changes
This is the simplest part
- With Git console above make sure you are still in the website directory
- Make sure you do not have files, such as a large image file or any notes that you do not want uploaded in the webserver directory or subdirectories
Run the following commands in one go after you have finished your edits from the website directory. Remember this is a collaborative system so their are potential conflicts. The system is designed to avoid conflicts and to help you resolve conflicts when they do occur. Most of the time you will not have conflicts to resolve. The first command tells git you want to add in changes to your local working copy of the file repository (repo). Remember the full stop at the end of the first command. The second command copies across your working copy changes to the local clone. The third command updates the local clone with any changes that have occurred and rewrites your commit history in such a way to make them easier to follow on top of the clone. The fourth command uses your local clone to write your changes to the repo on gitlab and triggers a rebuild with deploy
git add . git commit -m 'short relevant message about purpose of your changes' git pull --rebase git push
That is it. Wait a minute or so while the club website files are rebuilt and deployed.