Fix wget command and links in Readme (#4551)

* fix wget command in Readme
Fixes https://github.com/inventree/InvenTree/issues/4548
reported by @liuqun

* change doc links int markdown

* update bash script

* Add typing

* regenerate script

* fix link to contribute

* update more links

* remove additional whitespace
This commit is contained in:
Matthias Mair 2023-04-01 23:34:53 +02:00 committed by GitHub
parent d0f9d0d830
commit c28c991591
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 18 additions and 18 deletions

View File

@ -23,7 +23,7 @@ docker compose run inventree-dev-server invoke setup-test
docker compose up -d docker compose up -d
``` ```
Read the [InvenTree setup documentation](https://inventree.readthedocs.io/en/latest/start/intro/) for a complete installation reference guide. Read the [InvenTree setup documentation](https://docs.inventree.org/en/latest/start/intro/) for a complete installation reference guide.
### Setup Devtools ### Setup Devtools

View File

@ -21,7 +21,7 @@
<h4> <h4>
<a href="https://demo.inventree.org/">View Demo</a> <a href="https://demo.inventree.org/">View Demo</a>
<span> · </span> <span> · </span>
<a href="https://inventree.readthedocs.io/en/latest/">Documentation</a> <a href="https://docs.inventree.org/en/latest/">Documentation</a>
<span> · </span> <span> · </span>
<a href="https://github.com/inventree/InvenTree/issues/new?template=bug_report.md&title=[BUG]">Report Bug</a> <a href="https://github.com/inventree/InvenTree/issues/new?template=bug_report.md&title=[BUG]">Report Bug</a>
<span> · </span> <span> · </span>
@ -59,10 +59,10 @@ Powerful business logic works in the background to ensure that stock tracking hi
InvenTree is designed to be **extensible**, and provides multiple options for **integration** with external applications or addition of custom plugins: InvenTree is designed to be **extensible**, and provides multiple options for **integration** with external applications or addition of custom plugins:
* [InvenTree API](https://inventree.readthedocs.io/en/latest/extend/api/) * [InvenTree API](https://docs.inventree.org/en/latest/api/api/)
* [Python module](https://inventree.readthedocs.io/en/latest/extend/python) * [Python module](https://docs.inventree.org/en/latest/api/python/python/)
* [Plugin interface](https://inventree.readthedocs.io/en/latest/extend/plugins) * [Plugin interface](https://docs.inventree.org/en/latest/extend/plugins)
* [Third party tools](https://inventree.readthedocs.io/en/latest/extend/integrate) * [Third party tools](https://docs.inventree.org/en/latest/extend/integrate)
<!-- TechStack --> <!-- TechStack -->
### :space_invader: Tech Stack ### :space_invader: Tech Stack
@ -110,12 +110,12 @@ InvenTree is designed to be **extensible**, and provides multiple options for **
<!-- Getting Started --> <!-- Getting Started -->
## :toolbox: Getting Started ## :toolbox: Getting Started
Refer to the [getting started guide](https://inventree.readthedocs.io/en/latest/start/install/) for installation and setup instructions. Refer to the [getting started guide](https://docs.inventree.org/en/latest/start/install/) for installation and setup instructions.
<!-- Mobile App --> <!-- Mobile App -->
## :iphone: Mobile App ## :iphone: Mobile App
InvenTree is supported by a [companion mobile app](https://inventree.readthedocs.io/en/latest/app/app/) which allows users access to stock control information and functionality. InvenTree is supported by a [companion mobile app](https://docs.inventree.org/en/latest/app/app/) which allows users access to stock control information and functionality.
<div align="center"><h4> <div align="center"><h4>
<a href="https://play.google.com/store/apps/details?id=inventree.inventree_app">Android Play Store</a> <a href="https://play.google.com/store/apps/details?id=inventree.inventree_app">Android Play Store</a>
@ -129,23 +129,23 @@ InvenTree is supported by a [companion mobile app](https://inventree.readthedocs
There are several options to deploy InvenTree. There are several options to deploy InvenTree.
<div align="center"><h4> <div align="center"><h4>
<a href="https://inventree.readthedocs.io/en/latest/start/docker/">Docker</a> <a href="https://docs.inventree.org/en/latest/start/docker/">Docker</a>
<span> · </span> <span> · </span>
<a href="https://marketplace.digitalocean.com/apps/inventree?refcode=d6172576d014"><img src="https://www.deploytodo.com/do-btn-blue-ghost.svg" alt="Deploy to DO" width="auto" height="40" /></a> <a href="https://marketplace.digitalocean.com/apps/inventree?refcode=d6172576d014"><img src="https://www.deploytodo.com/do-btn-blue-ghost.svg" alt="Deploy to DO" width="auto" height="40" /></a>
<span> · </span> <span> · </span>
<a href="https://inventree.readthedocs.io/en/latest/start/install/">Bare Metal</a> <a href="https://docs.inventree.org/en/latest/start/install/">Bare Metal</a>
</h4></div> </h4></div>
Single line install - read [the docs](https://inventree.readthedocs.io/en/latest/start/installer/) for supported distros and details about the function: Single line install - read [the docs](https://docs.inventree.org/en/latest/start/installer/) for supported distros and details about the function:
```bash ```bash
wget -Oq install.sh https://get.inventree.org && bash install.sh wget -qO install.sh https://get.inventree.org && bash install.sh
``` ```
<!-- Contributing --> <!-- Contributing -->
## :wave: Contributing ## :wave: Contributing
Contributions are welcomed and encouraged. Please help to make this project even better! Contributions are welcomed and encouraged. Please help to make this project even better!
Refer to the [contribution page in the docs ](https://inventree.readthedocs.io/en/latest/contribute/) and check out [contributing.md](CONTRIBUTING.md). Refer to the [contribution page](CONTRIBUTING.md).
<!-- Translation --> <!-- Translation -->
## :scroll: Translation ## :scroll: Translation
@ -168,7 +168,7 @@ We would like to acknowledge a few special projects:
- [PartKeepr](https://github.com/partkeepr/PartKeepr) as a valuable predecessor and inspiration - [PartKeepr](https://github.com/partkeepr/PartKeepr) as a valuable predecessor and inspiration
- [Readme Template](https://github.com/Louis3797/awesome-readme-template) for the template of this page - [Readme Template](https://github.com/Louis3797/awesome-readme-template) for the template of this page
Find a full list of used third-party libraries in [our documentation](https://inventree.readthedocs.io/en/latest/credits/). Find a full list of used third-party libraries in [our documentation](https://docs.inventree.org/en/latest/credits/).
<!-- License --> <!-- License -->
## :warning: License ## :warning: License

View File

@ -86,8 +86,8 @@ root_command() {
esac esac
if [[ $SUPPORTED != "true" ]]; then if [[ $SUPPORTED != "true" ]]; then
echo "This OS is currently not supported" echo "This OS is currently not supported."
echo "please install manually using https://inventree.readthedocs.io/en/stable/start/install/" echo "Please install manually using https://docs.inventree.org/en/stable/start/install/"
echo "or check https://github.com/inventree/InvenTree/issues/3836 for packaging for your OS." echo "or check https://github.com/inventree/InvenTree/issues/3836 for packaging for your OS."
echo "If you think this is a bug please file an issue at" echo "If you think this is a bug please file an issue at"
echo "https://github.com/inventree/InvenTree/issues/new?template=install.yaml" echo "https://github.com/inventree/InvenTree/issues/new?template=install.yaml"

View File

@ -76,8 +76,8 @@ case "$OS" in
esac esac
if [[ $SUPPORTED != "true" ]]; then if [[ $SUPPORTED != "true" ]]; then
echo "This OS is currently not supported" echo "This OS is currently not supported."
echo "please install manually using https://inventree.readthedocs.io/en/stable/start/install/" echo "Please install manually using https://docs.inventree.org/en/stable/start/install/"
echo "or check https://github.com/inventree/InvenTree/issues/3836 for packaging for your OS." echo "or check https://github.com/inventree/InvenTree/issues/3836 for packaging for your OS."
echo "If you think this is a bug please file an issue at" echo "If you think this is a bug please file an issue at"
echo "https://github.com/inventree/InvenTree/issues/new?template=install.yaml" echo "https://github.com/inventree/InvenTree/issues/new?template=install.yaml"