solomax commented on code in PR #8: URL: https://github.com/apache/openjpa-site/pull/8#discussion_r4495109323
########## README.md: ########## @@ -1,13 +1,166 @@ -# Pelican ASF Website +# Apache OpenJPA Documentation Site -See [ASF-Pelican](https://infra.apache.org/asf-pelican.html) +This repository contains the documentation for Apache OpenJPA, a Java persistence project at The Apache Software Foundation. -See [migration notes](migration/README.md) +## Building the Site -# Documentation Branches +### Prerequisites -The following branches contain documentation which is directly published: -1. [Builds](../../tree/builds) - release documentation. -2. [Docs](../../tree/docs) - incubating release documentation. +- **Node.js** 22.x or later +- **Python** 3.12+ +- **pip** (Python package manager) +- **make** (optional, for convenience) -Commit to the [builds branch](../../tree/builds) when releasing new documentation. +### Setting up the Development Environment + +Since your environment has PEP 668 (externally-managed environment), you need to use a virtual environment: + +```bash +# Create a virtual environment +python3 -m venv venv + +# Activate the virtual environment +# On Linux/macOS: +source venv/bin/activate + +# On Windows: +# venv\Scripts\activate +``` + +### Installing Dependencies + +Once the virtual environment is activated: + +```bash +# Install Python dependencies +pip install pelican markdown beautifulsoup4 + +# Install npm dependencies +npm install +``` + +### Building the Site + +#### Development Build (with live reload) +```bash +# Build static assets (Bootstrap CSS/JS from npm packages) +npm run prepare + +# Build and serve with live reload +pelican content -s pelican.auto.py -l Review Comment: Just have tried it `make dev` also run `pelican content -s pelican.auto.py -lr` as it's final step as a result I'm getting: ``` Done: Processed 0 articles, 0 drafts, 0 hidden articles, 130 pages, 2 hidden pages and 0 draft pages in 2.83 seconds. Unable to watch path '/home/solomax/work/_oss/openjpa/rmannibucau-site/content/static' as it does not exist. ``` if I run `pelican content -s pelican.auto.py` then `pelican content -s pelican.auto.py -l` - everything is OK :)) -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
