mirror of https://github.com/snachodog/mybuddy.git
Fix broken hrefs in docs
This commit is contained in:
parent
92136569c4
commit
92071fbe19
|
@ -44,9 +44,9 @@ If no `Authorization` header set, or the key is not valid the API will return
|
|||
## Schema
|
||||
|
||||
The API schema in [OpenAPI format](https://swagger.io/specification/) can be
|
||||
found in the [`openapi-schema.yml`](/openapi-schema.yml) file in the project
|
||||
root. A live version is also available at the `/api/schema` path of a running
|
||||
instance.
|
||||
found in the [`openapi-schema.yml`](https://github.com/babybuddy/babybuddy/tree/master/openapi-schema.yml)
|
||||
file in the project root. A live version is also available at the `/api/schema` path of
|
||||
a running instance.
|
||||
|
||||
## `GET` Method
|
||||
|
||||
|
|
|
@ -44,7 +44,7 @@ information and steps below to set up a local development environment for Baby B
|
|||
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/setup/configuration.md) for other
|
||||
Linux-based systems. See [Configuration](../setup/configuration.md) for other
|
||||
settings and methods for defining them.
|
||||
|
||||
1. Migrate the database
|
||||
|
|
|
@ -2,9 +2,9 @@
|
|||
|
||||
## Definitions
|
||||
|
||||
Baby Buddy's Gulp commands are defined in [`gulpfile.js`](/gulpfile.js).
|
||||
Baby Buddy's Gulp commands are defined in [`gulpfile.js`](https://github.com/babybuddy/babybuddy/tree/master/gulpfile.js).
|
||||
|
||||
Baby Buddy's management commands are defined in [`babybuddy/management/commands`](/babybuddy/management/commands).
|
||||
Baby Buddy's management commands are defined in [`babybuddy/management/commands`](https://github.com/babybuddy/babybuddy/tree/master/babybuddy/management/commands).
|
||||
|
||||
## Commands
|
||||
|
||||
|
@ -54,8 +54,8 @@ for more details about other options and functionality of this command.
|
|||
|
||||
### `coverage`
|
||||
|
||||
Create a test coverage report. See [`.coveragerc`](/.coveragerc) for default
|
||||
settings information.
|
||||
Create a test coverage report. See [`.coveragerc`](https://github.com/babybuddy/babybuddy/tree/master/.coveragerc)
|
||||
for default settings information.
|
||||
|
||||
### `createcachetable`
|
||||
|
||||
|
@ -81,8 +81,8 @@ before commits to ensure linting will pass!
|
|||
|
||||
### `generateschema`
|
||||
|
||||
Updates the [`openapi-schema.yml`](/openapi-schema.yml) file in the project root
|
||||
based on current API functionality.
|
||||
Updates the [`openapi-schema.yml`](https://github.com/babybuddy/babybuddy/tree/master/openapi-schema.yml)
|
||||
file in the project root based on current API functionality.
|
||||
|
||||
### `lint`
|
||||
|
||||
|
@ -142,7 +142,7 @@ used for individual test execution.
|
|||
### `updateglyphs`
|
||||
|
||||
Downloads generated glyph font files data from [Fonttello](https://fontello.com/)
|
||||
based on [`config.json` file](/babybuddy/static_src/fontello/config.json). This
|
||||
based on [`config.json` file](https://github.com/babybuddy/babybuddy/tree/master/babybuddy/static_src/fontello/config.json). This
|
||||
only needs to be run after making changes to the config file.
|
||||
|
||||
### `updatestatic`
|
||||
|
|
|
@ -36,8 +36,8 @@ for more information on how to update the static files.
|
|||
|
||||
### Translations
|
||||
|
||||
Modifying [locale files](/locale) requires some extra steps. See [Translation](translation.md)
|
||||
for details.
|
||||
Modifying [locale files](https://github.com/babybuddy/babybuddy/tree/master/locale)
|
||||
requires some extra steps. See [Translation](translation.md) for details.
|
||||
|
||||
## Pull request process
|
||||
|
||||
|
|
|
@ -35,19 +35,18 @@ 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
|
||||
`scriptsConfig.graph`.
|
||||
1. Add the Plotly translation file path to [`gulpfile.config.js`](https://github.com/babybuddy/babybuddy/tree/master/gulpfile.config.js)
|
||||
in `scriptsConfig.graph`.
|
||||
|
||||
1. Build, collect, and commit the `/static` folder (see
|
||||
[`gulp updatestatic`](gulp-command-reference.md#updatestatic)).
|
||||
2. Build, collect, and commit the `/static` folder (see [`gulp updatestatic`](gulp-command-reference.md#updatestatic)).
|
||||
|
||||
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
|
||||
`scriptsConfig.vendor`.
|
||||
1. Add the Moment translation file path to [`gulpfile.config.js`](https://github.com/babybuddy/babybuddy/tree/master/gulpfile.config.js)
|
||||
in `scriptsConfig.vendor`.
|
||||
|
||||
1. Build, collect, and commit the `/static` folder (see
|
||||
2. Build, collect, and commit the `/static` folder (see
|
||||
[`gulp updatestatic`](gulp-command-reference.md#updatestatic)).
|
||||
|
||||
1. Run the development server, log in, and update the user language to test the
|
||||
|
|
|
@ -39,5 +39,5 @@ and formats. All rows will be checked for errors on import and any issues will
|
|||
be reported on screen and will need to be resolved before the import can be
|
||||
performed.
|
||||
|
||||
See the [example import files](/core/tests/import) used for tests to get an idea
|
||||
of the expected data format.
|
||||
See the [example import files](https://github.com/babybuddy/babybuddy/tree/master/core/tests/import)
|
||||
used for tests to get an idea of the expected data format.
|
||||
|
|
|
@ -165,8 +165,8 @@ settings form.
|
|||
|
||||
Whether to force 24-hour time format for locales that do not ordinarily use it
|
||||
(e.g. `en`). Support for this feature must be implemented on a per-locale basis.
|
||||
See format files under [`babybuddy/formats`](/babybuddy/formats) for supported
|
||||
locales.
|
||||
See format files under [`babybuddy/formats`](https://github.com/babybuddy/babybuddy/tree/master/babybuddy/formats)
|
||||
for supported locales.
|
||||
|
||||
Note: Baby Buddy interprets this value as a boolean from a string
|
||||
using Python's built-in [`strtobool`](https://docs.python.org/3/distutils/apiref.html#distutils.util.strtobool)
|
||||
|
|
|
@ -4,7 +4,7 @@ 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/setup/configuration.md) for detailed information.
|
||||
variables - see [Configuration](configuration.md) for detailed information.
|
||||
|
||||
## Docker
|
||||
|
||||
|
@ -54,7 +54,7 @@ create the following settings before pushing:
|
|||
heroku config:set SECRET_KEY=<CHANGE TO SOMETHING RANDOM>
|
||||
heroku config:set TIME_ZONE=<DESIRED DEFAULT TIMEZONE>
|
||||
|
||||
See [Configuration](/docs/setup/configuration.md) for other settings that can be controlled
|
||||
See [Configuration](configuration.md) for other settings that can be controlled
|
||||
by `heroku config:set`.
|
||||
|
||||
After an initial push, execute the following commands:
|
||||
|
|
Loading…
Reference in New Issue