Skip to content

Commit

Permalink
fix docs links
Browse files Browse the repository at this point in the history
  • Loading branch information
Archmonger committed Jul 1, 2024
1 parent 81fdca4 commit 56cd31d
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 72 deletions.
14 changes: 14 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Description

<!-- A summary of the changes. -->

## Checklist

Please update this checklist as you complete each item:

- [ ] Tests have been developed for bug fixes or new functionality.
- [ ] The changelog has been updated, if necessary.
- [ ] Documentation has been updated, if necessary.
- [ ] GitHub Issues closed by this PR have been linked.

<sub>By submitting this pull request I agree that all contributions comply with this project's open source license(s).</sub>
68 changes: 0 additions & 68 deletions .github/workflows/test-codeql-analysis.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/test-docs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Test
name: Documentation Tests

on:
push:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/configure/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
default-character-set = utf8
```

_Take a look at [MySQL's docs](https://dev.mysql.com/doc/refman/8.0/en/option-files.html) for all available parameters._
_Take a look at [MySQL's docs](https://dev.mysql.com/doc/refman/8.4/en/option-files.html) for all available parameters._

3. Set your `DB_ENGINE ` variable to `MYSQL` and your `MYSQL_CONFIG_FILE` variable to the path to your `mysql.cnf` file.

Expand Down
4 changes: 2 additions & 2 deletions docs/src/configure/webserver.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
We use [`hypercorn`](https://github.com/pgjones/hypercorn/) as Conreq's production-grade webserver. This webserver can be directly exposed to the internet. For more information beyond what is in this guide, check out the [`hypercorn` documentation](https://pgjones.gitlab.io/hypercorn/).
We use [`hypercorn`](https://github.com/pgjones/hypercorn/) as Conreq's production-grade webserver. This webserver can be directly exposed to the internet. For more information beyond what is in this guide, check out the [`hypercorn` documentation](https://hypercorn.readthedocs.io/en/latest/).

---

The Conreq webserver can be modified through a `hypercorn.toml` file.

1. Create a `hypercorn.toml` file within your Conreq data directory (such as `./conreq/data/hypercorn.toml`)

2. Populate this `toml` file with any property in the [`hypercorn`'s documentation](https://pgjones.gitlab.io/hypercorn/how_to_guides/configuring.html#configuration-options). For example...
2. Populate this `toml` file with any property in the [`hypercorn`'s documentation](https://hypercorn.readthedocs.io/en/latest/how_to_guides/configuring.html#configuration-options). For example...

```toml
bind = "0.0.0.0:5357"
Expand Down

0 comments on commit 56cd31d

Please sign in to comment.