Verified Commit 7ebc0c2f authored by noplanman's avatar noplanman
Browse files

Fix shortcut links and add changelog entry.

parent f095b907
...@@ -6,6 +6,7 @@ The format is based on [Keep a Changelog] and this project adheres to [Semantic ...@@ -6,6 +6,7 @@ The format is based on [Keep a Changelog] and this project adheres to [Semantic
- Added bootstrapping to simplify initialisation of config and database - Added bootstrapping to simplify initialisation of config and database
- Config syntax has changed to array style (#155) - Config syntax has changed to array style (#155)
- Added `pghost` config to set database port - Added `pghost` config to set database port
- Added `CONTRIBUTING.md`
### Changed ### Changed
- Introduce proper changelog format (#189) - Introduce proper changelog format (#189)
- Moved DB migration scripts into `db` folder - Moved DB migration scripts into `db` folder
......
...@@ -10,9 +10,9 @@ ...@@ -10,9 +10,9 @@
## Guidelines ## Guidelines
* Note your changes in [CHANGELOG.md] following https://keepachangelog.com * Note your changes in [`CHANGELOG.md`] following https://keepachangelog.com
* Create any necessary DB migration script in [db/migrations] and note them in the changelog. * Create any necessary DB migration script in [`db/migrations`] and note them in the changelog.
* Update [README.md] with needed changes * Update [`README.md`] with needed changes
* Update the [Wiki] with API changes * Update the [Wiki] with API changes
* Write your tests and validate them before you do your MR * Write your tests and validate them before you do your MR
...@@ -22,9 +22,9 @@ ...@@ -22,9 +22,9 @@
* CSS follows [CSSLint] * CSS follows [CSSLint]
* JS follows [ESLint] * JS follows [ESLint]
[README.md]: https://git.feneas.org/diasporg/Poduptime/blob/master/README.md [`README.md`]: https://git.feneas.org/diasporg/Poduptime/blob/master/README.md
[CHANGELOG.md]: https://git.feneas.org/diasporg/Poduptime/blob/master/CHANGELOG.md [`CHANGELOG.md`]: https://git.feneas.org/diasporg/Poduptime/blob/master/CHANGELOG.md
[db/migrations]: https://git.feneas.org/diasporg/Poduptime/tree/master/db/migrations [`db/migrations`]: https://git.feneas.org/diasporg/Poduptime/tree/master/db/migrations
[Wiki]: https://git.feneas.org/diasporg/Poduptime/wikis/home [Wiki]: https://git.feneas.org/diasporg/Poduptime/wikis/home
[PSR-2]: https://www.php-fig.org/psr/psr-2/ [PSR-2]: https://www.php-fig.org/psr/psr-2/
[CSSLint]: https://github.com/CSSLint/csslint [CSSLint]: https://github.com/CSSLint/csslint
......
...@@ -2,16 +2,16 @@ ...@@ -2,16 +2,16 @@
## New install ## New install
When setting up a new install, import [`db/tables.sql`][tables.sql] and do not perform any migrations! When setting up a new install, import [`db/tables.sql`] and do not perform any migrations!
## Migrating ## Migrating
If you are upgrading your existing installation, execute the necessary migrations scripts found in [`db/migrations`][migrations]. If you are upgrading your existing installation, execute the necessary migrations scripts found in [`db/migrations`].
## API v1 ## API v1
To support the original API v1 you should import [`db/pods_apiv1.sql`][pods_apiv1.sql] into your DB as often as you want your API updated. To support the original API v1 you should import [`db/pods_apiv1.sql`] into your DB as often as you want your API updated.
[tables.sql] https://git.feneas.org/diasporg/Poduptime/blob/master/db/tables.sql [`db/tables.sql`]: https://git.feneas.org/diasporg/Poduptime/blob/master/db/tables.sql
[migrations] https://git.feneas.org/diasporg/Poduptime/tree/master/db/migrations [`db/migrations`]: https://git.feneas.org/diasporg/Poduptime/tree/master/db/migrations
[pods_apiv1.sql] https://git.feneas.org/diasporg/Poduptime/blob/master/db/pods_apiv1.sql [`db/pods_apiv1.sql`]: https://git.feneas.org/diasporg/Poduptime/blob/master/db/pods_apiv1.sql
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment