Skip to content

Commit

Permalink
Minor text changes and corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
PGijsbers committed Oct 21, 2023
1 parent 1f8aabe commit 74cf33c
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/contributing/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ checks pass out of the box:

```bash title="Install pre-commit and verify it works"
pre-commit install
pre-commit run all-files
pre-commit run --all-files
```
Running the tool the first time may be slow as tools need to be installed,
and many tools will build a cache so subsequent runs are faster.
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,6 @@ For larger changes, clone a fork of the repository as described in the
python -m mkdocs serve
```

This will serve the documentation from the `docs/` directory to [https://localhost:8000/](https://localhost:8000/).
This will serve the documentation from the `docs/` directory to [http://localhost:8000/](http://localhost:8000/).
Any updates you make to files in that directory will be reflected on the website.
When you are happy with your changes, just commit and set up a pull request!
6 changes: 3 additions & 3 deletions docs/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ documentation.

### Bug reports

When you encounter an issue using or deploying the Python-based REST API, the first
When you encounter an issue using or deploying the Python-based REST API, the first step
is to search our [issue tracker](https://github.com/openml/server-api/issues) to see if others
have already reported the issue. If this is the case, please indicate that you encountered
the issue by leaving a :+1: on the issue. Feel free to leave a comment if you have
additional information that may be useful to fix the bug.
additional information that may be useful to track down or fix the bug.

If the bug has not been reported before, please open a new issue to report it.
When you open a bug report, please include:
Expand All @@ -30,7 +30,7 @@ that describes what the contribution should look like. This may be a proposal th
write yourself, or an existing open issue that you want to help us with. Please indicate
on that issue that you would like to contribute to it. This way, we can ensure that
everything is clear, it's not out of date, and "officially" assign you to the issue so
that others know its being worked on! Making sure there is a clear description and clear
that others know its being worked on. Making sure there is a clear description and clear
assignment helps prevent a situation where someone makes a large contribution that is
unwanted, or is simultaneously developed by someone else. With an issue assigned,
please head over to the "[Development](contributing.md)" section.
Expand Down
6 changes: 4 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,10 @@ on the same network. For example:
```bash
docker run --network NETWORK --rm -it mysql mysql -hopenml-test-database -uroot -pok
```
where `NETWORK` is `server-api_default` if you used `docker compose`, and `openml`
when using `docker run` (or whatever network you specified instead).
where `NETWORK` is `openml` when using `docker run` when following the example,
and `NETWORK` is `server-api_default` if you used `docker compose` (specifically,
it is `DIRECTORY_NAME` + `_default`, so if you renamed the `server-api` directory to
something else, the network name reflects that).

## Configuring the REST API Server

Expand Down

0 comments on commit 74cf33c

Please sign in to comment.