mirror of
https://github.com/boostorg/website-v2.git
synced 2026-01-19 04:42:17 +00:00
a1d51bb792
Testing docker-compose. Here are things I noticed. - `styles.css` seemed to be missing in the local docker-compose environment, even though it's present in the docker image. With docker-compose a volume is mounted. The volume points to your git repository where styles.css is now git-ignored. Therefore, I am adding steps in the README to build `styles.css`. @kennethreitz @rbbeeston , is this incorrect? Should the instructions be different? What method do you use? - local development: there had been a note to install Python 3.11. Even though Django containers are running with Python 3.11, it should be acceptable for the local OS to have the system default of Python 3.10. They are not directly interacting. Don't modify the system python. - To view the Users Guide and Contributors Guide, adding variables to the env.template (and your .env file) ``` STATIC_CONTENT_AWS_ACCESS_KEY_ID= STATIC_CONTENT_AWS_SECRET_ACCESS_KEY= STATIC_CONTENT_BUCKET_NAME= STATIC_CONTENT_REGION= STATIC_CONTENT_AWS_S3_ENDPOINT_URL= ``` If anyone uses docker-compose and notices the instructions are incomplete, please comment and/or contribute fixes to the docs.
Documentation for the Boost Website
- API Documentation - We don't have many API endpoints, but the ones we do have are documented here
- Boost Mailing List -Includes OAuth instructions
- Caching and the
RenderedContentmodel - Dependency Management
- Development Setup Notes
- Environment Variables
- Events Calendar
- Example Files - Contains samples of
libraries.json..gitmodules, and other files that Boost data depends on - Hosting
- Mailman
- Management Commands
- News and Moderation
- Retrieving Static Content from the Boost Amazon S3 Bucket
- RSS Feeds
- Syncing Data about Boost Versions and Libraries with GitHub
- User Management - Describes how we allow authors and maintainers to "claim" the accounts that we create for them as part of the library upload process, and how to prevent users from updating their own profile photos.