Add initial mkdocs config

This commit is contained in:
Christopher C. Wells 2021-12-21 16:45:50 -05:00
parent db703c07ec
commit cbc2fed2fb
12 changed files with 38 additions and 52 deletions

3
.gitignore vendored
View File

@ -28,3 +28,6 @@
# requirements can different between versions, but the Pipfile only supports
# locking to one version.
Pipfile.lock
# Documentation
/site

View File

@ -27,3 +27,4 @@ coveralls = "*"
flake8 = "*"
ipaddress = "*"
tblib = "*"
mkdocs = "*"

View File

@ -26,12 +26,11 @@ The demo instance resets every hour. Login credentials are:
## Documentation
- [Table of Contents](/docs/TOC.md)
- [Deployment](/docs/DEPLOYMENT.md)
- [Configuration](/docs/CONFIGURATION.md)
- [Import/Export](/docs/IMPORT_EXPORT.md)
- [API](/docs/API.md)
- [Contributing](/docs/CONTRIBUTING.md)
- [Deployment](/docs/deployment.md)
- [Configuration](/docs/configuration.md)
- [Import/Export](/docs/import_export.md)
- [API](/docs/api.md)
- [Contributing](/docs/contributing.md)
- [Changelog](/CHANGELOG.md)
- [Security](/SECURITY.md)
- [LICENSE](/LICENSE) (BSD-2 Clause)
@ -40,7 +39,7 @@ The demo instance resets every hour. Login credentials are:
Baby Buddy is available in a variety of languages thanks to the efforts of numerous
translators. Language can be set on a per-user basis from the user settings page
(`/user/settings/`). See [CONTRIBUTING.md](/docs/CONTRIBUTING.md#translation)
(`/user/settings/`). See [CONTRIBUTING.md](/docs/contributing.md#translation)
for information about how to create/update translations.
### Available languages

1
docs/CNAME Normal file
View File

@ -0,0 +1 @@
docs.baby-buddy.net

View File

@ -1,30 +0,0 @@
# Baby Buddy Documentation
- [README](/README.md)
General information about Baby Buddy.
- [Deployment](/docs/DEPLOYMENT.md)
How to deploy Baby Buddy manually or using Docker or Heroku.
- [Configuration](/docs/CONFIGURATION.md)
How to set application-wide configuration options using environment variables.
- [Import/Export](/docs/IMPORT_EXPORT.md)
How to import data in to Baby Buddy and export data from it (easily!).
- [API](/docs/API.md)
Information about Baby Buddy's robust API.
- [Contributing](/docs/CONTRIBUTING.md)
How to contribute to Baby Buddy as a developer or translator.

View File

@ -1,5 +1,4 @@
# API
[Back to Table of Contents](/docs/TOC.md)
Baby Buddy uses the [Django REST Framework](https://www.django-rest-framework.org/)
(DRF) to provide a REST API.

View File

@ -1,5 +1,4 @@
# Configuration
[Back to Table of Contents](/docs/TOC.md)
Environment variables can be used to define a number of configuration settings.
Baby Buddy will check the application directory structure for an `.env` file or

View File

@ -1,5 +1,4 @@
# Contributing
[Back to Table of Contents](/docs/TOC.md)
Baby Buddy's maintainers accept and encourage contributions via GitHub [Issues](https://github.com/babybuddy/babybuddy/issues)
and [Pull Requests](https://github.com/babybuddy/babybuddy/pulls). Maintainers
@ -56,7 +55,7 @@ compile an optimized translation file (`locale/xx/LC_MESSAGES/django.mo`).
1. Check if Plotly offers a translation (in `node_modules/plotly.js/dist/`) for
the language. If it does:
1. Add the Plotly translation file path to [`gulpfile.config.js`](gulpfile.config.js) in
1. Add the Plotly translation file path to [`gulpfile.config.js`](/gulpfile.config.js) in
`scriptsConfig.graph`.
1. Build, collect, and commit the `/static` folder (see
@ -65,7 +64,7 @@ the language. If it does:
1. Check if Moment offers a translation (in `node_modules/moment/locale/`) for
the language. If it does:
1. Add the Moment translation file path to [`gulpfile.config.js`](gulpfile.config.js) in
1. Add the Moment translation file path to [`gulpfile.config.js`](/gulpfile.config.js) in
`scriptsConfig.vendor`.
1. Build, collect, and commit the `/static` folder (see
@ -121,7 +120,7 @@ documentation section: [Translation](https://docs.djangoproject.com/en/3.0/topic
export DJANGO_SETTINGS_MODULE=babybuddy.settings.development
This process will differ based on the host OS. The above example is for
Linux-based systems. See [Configuration](/docs/CONFIGURATION.md) for other
Linux-based systems. See [Configuration](/docs/configuration.md) for other
settings and methods for defining them.
1. Migrate the database
@ -144,9 +143,9 @@ username and password (`admin`/`admin`).
### Gulp commands
[`gulpfile.js`](gulpfile.js) defines Baby Buddy's Gulp commands.
[`gulpfile.js`](/gulpfile.js) defines Baby Buddy's Gulp commands.
[`babybuddy/management/commands`](babybuddy/management/commands) defines Baby Buddy's
[`babybuddy/management/commands`](/babybuddy/management/commands) defines Baby Buddy's
management commands.
- [`gulp`](#gulp)

View File

@ -1,11 +1,10 @@
# Deployment
[Back to Table of Contents](/docs/TOC.md)
The default username and password for Baby Buddy is `admin`/`admin`. For any
deployment, **log in and change the default password immediately**.
Many of Baby Buddy's configuration settings can be controlled using environment
variables - see [Configuration](/docs/CONFIGURATION.md) for detailed information.
variables - see [Configuration](/docs/configuration.md) for detailed information.
## Docker
@ -55,7 +54,7 @@ create the following settings before pushing:
heroku config:set DISABLE_COLLECTSTATIC=1
heroku config:set TIME_ZONE=<DESIRED DEFAULT TIMEZONE>
See [Configuration](/docs/CONFIGURATION.md) for other settings that can be controlled
See [Configuration](/docs/configuration.md) for other settings that can be controlled
by `heroku config:set`.
After an initial push, execute the following commands:

View File

@ -1,10 +1,9 @@
## Import/Export
[Back to Table of Contents](/docs/TOC.md)
# Import/Export
Baby Buddy uses the [django-import-export application](https://django-import-export.readthedocs.io/)
to provide import and export functionality.
### Export
## Export
Export actions are accessible from Baby Buddy's "Database Admin" area (the
Django admin interface). For example, to export all diaper change entries from
@ -26,7 +25,7 @@ on the Diaper Change list screen (step 3 above), it is possible to select one
or many individual records and select "Export selected Diaper Changes" from the
"Actions" list.
### Import
## Import
Import actions are accessible from Baby Buddy's "Database Admin" area (the
Django admin interface). From the list of entry types in the Database Admin,

13
docs/index.md Normal file
View File

@ -0,0 +1,13 @@
# Home
A buddy for babies! Helps caregivers track sleep, feedings, diaper changes,
tummy time and more to learn about and predict baby's needs without (*as much*)
guess work.
## Demo
A [demo of Baby Buddy](http://demo.baby-buddy.net) is available on Heroku.
The demo instance resets every hour. Login credentials are:
- Username: `admin`
- Password: `admin`

4
mkdocs.yml Normal file
View File

@ -0,0 +1,4 @@
site_name: Baby Buddy
site_url: https://docs.baby-buddy.net
theme: readthedocs