mirror of https://github.com/snachodog/mybuddy.git
Add initial mkdocs config
This commit is contained in:
parent
db703c07ec
commit
cbc2fed2fb
|
@ -28,3 +28,6 @@
|
||||||
# requirements can different between versions, but the Pipfile only supports
|
# requirements can different between versions, but the Pipfile only supports
|
||||||
# locking to one version.
|
# locking to one version.
|
||||||
Pipfile.lock
|
Pipfile.lock
|
||||||
|
|
||||||
|
# Documentation
|
||||||
|
/site
|
||||||
|
|
1
Pipfile
1
Pipfile
|
@ -27,3 +27,4 @@ coveralls = "*"
|
||||||
flake8 = "*"
|
flake8 = "*"
|
||||||
ipaddress = "*"
|
ipaddress = "*"
|
||||||
tblib = "*"
|
tblib = "*"
|
||||||
|
mkdocs = "*"
|
||||||
|
|
13
README.md
13
README.md
|
@ -26,12 +26,11 @@ The demo instance resets every hour. Login credentials are:
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
- [Table of Contents](/docs/TOC.md)
|
- [Deployment](/docs/deployment.md)
|
||||||
- [Deployment](/docs/DEPLOYMENT.md)
|
- [Configuration](/docs/configuration.md)
|
||||||
- [Configuration](/docs/CONFIGURATION.md)
|
- [Import/Export](/docs/import_export.md)
|
||||||
- [Import/Export](/docs/IMPORT_EXPORT.md)
|
- [API](/docs/api.md)
|
||||||
- [API](/docs/API.md)
|
- [Contributing](/docs/contributing.md)
|
||||||
- [Contributing](/docs/CONTRIBUTING.md)
|
|
||||||
- [Changelog](/CHANGELOG.md)
|
- [Changelog](/CHANGELOG.md)
|
||||||
- [Security](/SECURITY.md)
|
- [Security](/SECURITY.md)
|
||||||
- [LICENSE](/LICENSE) (BSD-2 Clause)
|
- [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
|
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
|
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.
|
for information about how to create/update translations.
|
||||||
|
|
||||||
### Available languages
|
### Available languages
|
||||||
|
|
|
@ -0,0 +1 @@
|
||||||
|
docs.baby-buddy.net
|
30
docs/TOC.md
30
docs/TOC.md
|
@ -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.
|
|
|
@ -1,5 +1,4 @@
|
||||||
# API
|
# API
|
||||||
[Back to Table of Contents](/docs/TOC.md)
|
|
||||||
|
|
||||||
Baby Buddy uses the [Django REST Framework](https://www.django-rest-framework.org/)
|
Baby Buddy uses the [Django REST Framework](https://www.django-rest-framework.org/)
|
||||||
(DRF) to provide a REST API.
|
(DRF) to provide a REST API.
|
|
@ -1,5 +1,4 @@
|
||||||
# Configuration
|
# Configuration
|
||||||
[Back to Table of Contents](/docs/TOC.md)
|
|
||||||
|
|
||||||
Environment variables can be used to define a number of configuration settings.
|
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
|
Baby Buddy will check the application directory structure for an `.env` file or
|
|
@ -1,5 +1,4 @@
|
||||||
# Contributing
|
# 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)
|
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
|
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
|
1. Check if Plotly offers a translation (in `node_modules/plotly.js/dist/`) for
|
||||||
the language. If it does:
|
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`.
|
`scriptsConfig.graph`.
|
||||||
|
|
||||||
1. Build, collect, and commit the `/static` folder (see
|
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
|
1. Check if Moment offers a translation (in `node_modules/moment/locale/`) for
|
||||||
the language. If it does:
|
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`.
|
`scriptsConfig.vendor`.
|
||||||
|
|
||||||
1. Build, collect, and commit the `/static` folder (see
|
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
|
export DJANGO_SETTINGS_MODULE=babybuddy.settings.development
|
||||||
|
|
||||||
This process will differ based on the host OS. The above example is for
|
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.
|
settings and methods for defining them.
|
||||||
|
|
||||||
1. Migrate the database
|
1. Migrate the database
|
||||||
|
@ -144,9 +143,9 @@ username and password (`admin`/`admin`).
|
||||||
|
|
||||||
### Gulp commands
|
### 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.
|
management commands.
|
||||||
|
|
||||||
- [`gulp`](#gulp)
|
- [`gulp`](#gulp)
|
|
@ -1,11 +1,10 @@
|
||||||
# Deployment
|
# Deployment
|
||||||
[Back to Table of Contents](/docs/TOC.md)
|
|
||||||
|
|
||||||
The default username and password for Baby Buddy is `admin`/`admin`. For any
|
The default username and password for Baby Buddy is `admin`/`admin`. For any
|
||||||
deployment, **log in and change the default password immediately**.
|
deployment, **log in and change the default password immediately**.
|
||||||
|
|
||||||
Many of Baby Buddy's configuration settings can be controlled using environment
|
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
|
## Docker
|
||||||
|
|
||||||
|
@ -55,7 +54,7 @@ create the following settings before pushing:
|
||||||
heroku config:set DISABLE_COLLECTSTATIC=1
|
heroku config:set DISABLE_COLLECTSTATIC=1
|
||||||
heroku config:set TIME_ZONE=<DESIRED DEFAULT TIMEZONE>
|
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`.
|
by `heroku config:set`.
|
||||||
|
|
||||||
After an initial push, execute the following commands:
|
After an initial push, execute the following commands:
|
|
@ -1,10 +1,9 @@
|
||||||
## Import/Export
|
# Import/Export
|
||||||
[Back to Table of Contents](/docs/TOC.md)
|
|
||||||
|
|
||||||
Baby Buddy uses the [django-import-export application](https://django-import-export.readthedocs.io/)
|
Baby Buddy uses the [django-import-export application](https://django-import-export.readthedocs.io/)
|
||||||
to provide import and export functionality.
|
to provide import and export functionality.
|
||||||
|
|
||||||
### Export
|
## Export
|
||||||
|
|
||||||
Export actions are accessible from Baby Buddy's "Database Admin" area (the
|
Export actions are accessible from Baby Buddy's "Database Admin" area (the
|
||||||
Django admin interface). For example, to export all diaper change entries from
|
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
|
or many individual records and select "Export selected Diaper Changes" from the
|
||||||
"Actions" list.
|
"Actions" list.
|
||||||
|
|
||||||
### Import
|
## Import
|
||||||
|
|
||||||
Import actions are accessible from Baby Buddy's "Database Admin" area (the
|
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,
|
Django admin interface). From the list of entry types in the Database Admin,
|
|
@ -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`
|
|
@ -0,0 +1,4 @@
|
||||||
|
site_name: Baby Buddy
|
||||||
|
site_url: https://docs.baby-buddy.net
|
||||||
|
|
||||||
|
theme: readthedocs
|
Loading…
Reference in New Issue