This project consists of static web pages providing information for Lake Afton Public Obversatory volunteers.s
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See Build and Deployment below for notes on how to deploy the project on a live system.
Use the Review Block (see section below) at the bottom of each page within these Documents to track Review and remaining tasks for the content of the page. @mention specific project team members to capture their attention that input is needed to clarify and review the content (example below):
Documentation and Quick Reference:
hugo list drafts [flags]
Use the following HUGO Front Matter tags (located at very top of document) to indicate the status of last reviewed, reviewer and any note related to content:
lastmod: "2024-07-18"
reviewer: "Chris Ketron"
notes: "TODO: This is an example `Review Block` to track content review of pages within the Documents. @Chris.Ketron: Please review this document"
---
This information will be used to produce the Review Block that you see below (automatically produced when Hugo renders static pages):
| Review Block | |
|---|---|
| Last reviewed | 2024-07-18 |
| Reviewed by | Chris Ketron |
| Notes | TODO: This is an example Review Block to track content review of pages within the Documents. @Chris.Ketron: Please review this document |
=== === ===
This project was built using the following environment components:
The following are the steps I used to create the fresh LAPO Volunteer Handbook project, and these notes can be used for creating a fresh, brand-new project. However, if you are just cloning the existing ELAPO Volunteer Handbook project from GitHub, then you can skip these steps and go directly to Clone this Project
Create a virtual environment for the LAPO Volunteer Handbook Project.
Begin by creating a directory for the Python virtual environment;
Example... from within your volunteer-handbook project folder
virtualenv venv
You can do this from any folder location, recommend from your local github\volunteer-handbook project folder
venv\Scripts\activate.bat
See the pip-dependencies.txt file for the Python package requirements for the LAPO Volunteer Handbook:
Short-cut: to install ALL pip dependencies: The following must be done from your local github\volunteer-handbook project folder, where the pip-dependencies.txt exists...
pip install -r pip-dependencies.txtTo start the Hugo dev server for testing. From the volunteer-handbook folder, execute the following command
hugo server -D
You can then open the local site (url displayed in the output from above conmand) for testing:
From the GitHub repository: https://github.com/lake-afton-public-observatory/volunteer-handbook.git select Clone and copy the URL to the repo.
Then from your local project folder (I am using c:\git\github), execute the following git command:
git clone https://github.com/lake-afton-public-observatory/volunteer-handbook.git
Once all editing has been completed, do a final build of the document site for deployment
hugo
This command will generate the various pages from the markdown files and place them in the "public" sub-directory. This is the folder that contains the generated static website and should be copied to the deployment destination.
You can use the Python Simple HTTP server that comes with Python to start up a local server. Change directory into the Site folder and execute the following:
python -m http.server 8080
Then visit the site by visiting the following address in your browser:
Once the build has completed, a public folder will be found in your project repo folder.
This public folder now contains the resources for a static website deployment. Copy the contents to a destination server and execute the startLAPOHandbook.bat for the target browser to host the notes locally.
For the sake of tracking version history, the version numbering will follow a year, month, date numbering sequence, following by a sequence id to account for multiple versions within a single date, in the following format:
yyyy.MM.dd.#
e.g.,... 2024.07.18.0
Use this versioning strategy when applying label to the source.
Please submit any questions or suggestions regarding content to the Lake Afton Public Observatory Board of Directors @mailto:board@lakeafton.com.
This Lake Afton Public Observatory Volunteer Handbook has been compiled, reviewed and approved by the Lake Afton Public Observatory Board of Directors.
- Download the latest zipped Hugo executable from Hugo Release.
- Extract the zip into your C drive for eg.
C:\hugo - Add the
hugo.exeexecutable to your PATH. - Open a new cmd prompt window and you should now be able to run
hugo versioncommand. If you get "hugo command not found" , please make sure you have configured the PATH correctly. - In the command prompt, navigate to the root of the folder where you have cloned this repo.
- Once you are inside handbook folder, run
hugo server -Dand you should see the below output.
C:\Users\{user-id}\handbook>hugo server -D
Start building sites …
hugo v0.88.1-5BC54738 windows/amd64 BuildDate=2021-09-04T09:39:19Z VendorInfo=gohugoio
| EN
-------------------+------
Pages | 199
Paginator pages | 0
Non-page files | 16
Static files | 3
Processed images | 0
Aliases | 17
Sitemaps | 1
Cleaned | 0
Built in 743 ms
Watching for changes in C:\Users\{user-id}\handbook\{archetypes,content,themes}
Watching for config changes in C:\Users\{user-id}\handbook\config\_default, C:\Users\{user-id}\handbook\config\development
Environment: "development"
Serving pages from memory
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at http://localhost:1313/handbook/ (bind address 127.0.0.1)
Press Ctrl+C to stop
- Open the browser and navigate to the localhost url which is generated in above logs and you should be able to see the site load.
- Press
ctrl+cto stop the local dev server.