lewismc commented on code in PR #3: URL: https://github.com/apache/gora-site/pull/3#discussion_r1552055862
########## README.md: ########## @@ -1,5 +1,43 @@ -# Pelican ASF Website +# Apache Gora Website -See [ASF-Pelican](https://infra.apache.org/asf-pelican.html) +Welcome to the Apache Gora website repository! This README provides guidance on building the website locally for development or testing purposes. -See [migration notes](migration/README.md) +## Building Locally + +To build this website locally, follow these steps: + +### Prerequisites +- Ensure that you have [Python 3](https://python.org) installed on your system. + +### Setup +1. Clone this repository to your local machine. + +```bash +git clone https://github.com/apache/gora-site.git +``` + +2. (Optional) Set up a new Python virtual environment. + +```bash +python3 -m venv env +source env/bin/activate +``` + +3. Install the required Python packages using pip. + +```bash +pip install -r requirements.txt +``` +> Note: You may also need to run `pip install pelican[markdown]` + +### Building +4. Utilize Pelican to generate the website. + +```bash +pelican content Review Comment: I was able to see the website deployed locally with `pelican content -l`. `stdout` complained about `Cannot load plugin pelican-gfm` Content was served at http://127.0.0.1:8000 which is really useful ########## README.md: ########## @@ -1,5 +1,43 @@ -# Pelican ASF Website +# Apache Gora Website -See [ASF-Pelican](https://infra.apache.org/asf-pelican.html) +Welcome to the Apache Gora website repository! This README provides guidance on building the website locally for development or testing purposes. -See [migration notes](migration/README.md) +## Building Locally + +To build this website locally, follow these steps: + +### Prerequisites +- Ensure that you have [Python 3](https://python.org) installed on your system. + +### Setup +1. Clone this repository to your local machine. + +```bash +git clone https://github.com/apache/gora-site.git +``` + +2. (Optional) Set up a new Python virtual environment. + +```bash +python3 -m venv env +source env/bin/activate +``` + +3. Install the required Python packages using pip. + +```bash +pip install -r requirements.txt +``` +> Note: You may also need to run `pip install pelican[markdown]` Review Comment: ``` (env) ➜ gora-site git:(main) pip install pelican[markdown] zsh: no matches found: pelican[markdown] ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@gora.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
