Skip to content

docs: fix stale file paths in CONTRIBUTING and server-config #663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ZayanKhan-12 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: fix stale file paths in CONTRIBUTING and server-config #663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ or npm [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli).
TOC for markdown file is built with [markdown-toc](https://www.npmjs.com/package/markdown-toc):

```sh
markdown-toc -i docs/server-startup.md
markdown-toc -i docs/server-install.md
```

To check markdown style for all the documentation use `markdownlint`:
Expand All @@ -120,7 +120,7 @@ These checks will run as part of the build if you submit a pull request.

You can invoke the TabPy Server API against a running TabPy instance with Swagger.

- Make CORS related changes in TabPy configuration file: update `tabpy/tabpy-server/state.ini`
- Make CORS related changes in TabPy configuration file: update `tabpy/tabpy_server/state.ini`
file in your local repository to have the next settings:

```config
Expand All @@ -130,7 +130,7 @@ Access-Control-Allow-Headers = Origin, X-Requested-with, Content-Type
Access-Control-Allow-Methods = GET, OPTIONS, POST
```

- Start a local instance of TabPy server following [TabPy Server Startup Guide](docs/server-startup.md).
- Start a local instance of TabPy server following [TabPy Server Startup Guide](docs/server-install.md).
- Run a local copy of Swagger editor with steps provided at
[https://github.com/swagger-api/swagger-editor](https://github.com/swagger-api/swagger-editor).
- Open `misc/TabPy.yml` in Swagger editor.
Expand Down
2 changes: 1 addition & 1 deletion docs/server-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ as explained in Python documentation at
[Logging Configuration page](https://docs.python.org/3.6/library/logging.config.html).

A default config provided with TabPy is at
[`tabpy-server/tabpy_server/common/default.conf`](tabpy-server/tabpy_server/common/default.conf)
[`tabpy/tabpy_server/common/default.conf`](../tabpy/tabpy_server/common/default.conf)
and has a configuration for console and file loggers. Changing the config file
allows the user to modify the log level, format of the logged messages and
add or remove loggers.
Expand Down