diff options
Diffstat (limited to 'docs/en/developers')
| -rw-r--r-- | docs/en/developers/01_Index.md | 2 | ||||
| -rw-r--r-- | docs/en/developers/02_GitHub.md | 2 | ||||
| -rw-r--r-- | docs/en/developers/03_Running_tests.md | 4 | ||||
| -rw-r--r-- | docs/en/developers/06_Reporting_Bugs.md | 4 |
4 files changed, 6 insertions, 6 deletions
diff --git a/docs/en/developers/01_Index.md b/docs/en/developers/01_Index.md index 0e59b8c12..50ba84285 100644 --- a/docs/en/developers/01_Index.md +++ b/docs/en/developers/01_Index.md @@ -31,4 +31,4 @@ Start by creating your development environment. A guide to setting up FreshRSS†## Minz -Minz is the homemade PHP framework used by FreshRSS. More information can be found [here](Minz/index.md). +Minz is the homemade PHP framework used by FreshRSS. See the [dedicated documentation](Minz/index.md). diff --git a/docs/en/developers/02_GitHub.md b/docs/en/developers/02_GitHub.md index 066d6ffb0..51324349e 100644 --- a/docs/en/developers/02_GitHub.md +++ b/docs/en/developers/02_GitHub.md @@ -59,4 +59,4 @@ A commit message should succinctly describe the changes on the first line. For e If necessary, this can be followed by a blank line and a longer explanation. -For further tips, see [here](https://chris.beams.io/posts/git-commit/). +For further tips, see [here (chris.beams.io)](https://chris.beams.io/posts/git-commit/). diff --git a/docs/en/developers/03_Running_tests.md b/docs/en/developers/03_Running_tests.md index dabff8477..c5f962a6d 100644 --- a/docs/en/developers/03_Running_tests.md +++ b/docs/en/developers/03_Running_tests.md @@ -42,7 +42,7 @@ If you are interested, you can take a look at [the configuration file](https://g ## Using feed snapshots As feed data is volatile, it’s better to work with snapshots when debugging some issues. -You can find the description to retrieve a snapshot [here](06_Reporting_Bugs.md#how-to-provide-feed-data). +Check the [description to retrieve a snapshot](06_Reporting_Bugs.md#how-to-provide-feed-data). To serve those snapshots, you can use a mock server. Here we will demonstrate how to work with [WireMock](https://wiremock.org/) but other solutions exist. @@ -70,7 +70,7 @@ If you do not have one, you need to create one. } ``` 1. Launch the containerized server with the following command: - ```bash + ```sh # <PORT> is the port used on the host to communicate with the server # <NETWORK> is the name of the docker network used (by default, it’s freshrss-network) docker run -it --rm -p <PORT>:8080 --name wiremock --network <NETWORK> -v $PWD:/home/wiremock wiremock/wiremock:latest-alpine --local-response-templating diff --git a/docs/en/developers/06_Reporting_Bugs.md b/docs/en/developers/06_Reporting_Bugs.md index 0c5d255ff..0707fcba3 100644 --- a/docs/en/developers/06_Reporting_Bugs.md +++ b/docs/en/developers/06_Reporting_Bugs.md @@ -37,7 +37,7 @@ Here are some tips to help you present your bug report or suggestion: * Not all bugs require logs, but if you have any doubts, it is better to provide them to us. Logs are important and very useful for debugging! * The logs may reveal confidential information, so **be careful not to disclose anything sensitive.** * If you report a feed problem, it will be easier if you could provide a snapshot of its content in a text file. -See [here](#how-to-provide-feed-data) for more information. +See [further down](#how-to-provide-feed-data) for more information. In addition, when facing a bug, you’re encouraged to follow this message format (from the [Sam & Max website](http://sametmax.com/template-de-demande-daide-en-informatique/): @@ -72,7 +72,7 @@ Remember to give the following information if you know it: If you need us to investigate a feed problem, it will be easier if you provide a snapshot of the feed data. To do that, you can launch the following command: -```bash +```sh wget <feed url> -O output.rss.txt ``` Then you can drag-and-drop the generated file into the issue. |