Skip to content
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.

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

docs: cleanup and normalization #2636

Merged
merged 61 commits into from
Feb 1, 2024
Merged
Changes from 1 commit
Commits
Show all changes
61 commits
Select commit Hold shift + click to select a range
6f33eed
docs: move restart docs under Cumulocity
reubenmiller Jan 29, 2024
9876546
add c8y tag to device restart page
reubenmiller Jan 29, 2024
03167c5
docs: move c8y connection docs under c8y folder
reubenmiller Jan 29, 2024
625d288
docs: rename health monitoring file
reubenmiller Jan 29, 2024
5c1f97d
docs: rename apama page
reubenmiller Jan 29, 2024
7198bd4
docs: rename config management page
reubenmiller Jan 29, 2024
df715c4
docs: rename log management page
reubenmiller Jan 29, 2024
3b5d002
docs: rename and cleanup remote access page
reubenmiller Jan 29, 2024
4c94468
docs: rename restart device
reubenmiller Jan 29, 2024
9a42efc
docs: reformat page
reubenmiller Jan 29, 2024
f2332a5
docs: rename title page
reubenmiller Jan 29, 2024
5577604
page: remove explicit title and sidebar position
reubenmiller Jan 29, 2024
31e8b44
docs: rename configuration management page to align with title
reubenmiller Jan 29, 2024
f4b5745
docs: use official SmartREST name
reubenmiller Jan 29, 2024
947f964
docs: move software management page
reubenmiller Jan 29, 2024
8b53bf6
docs: align title with file name
reubenmiller Jan 30, 2024
3a68c10
docs(customfragments): refactor docs
reubenmiller Jan 30, 2024
33a7eb6
docs(connect): modify note about requiring sudo to be more technicall…
reubenmiller Jan 30, 2024
97c31bb
docs(operations): remove empty operations page
reubenmiller Jan 30, 2024
5086016
docs: rename mqtt api doc
reubenmiller Jan 30, 2024
c44a12d
doc: rename configuration files reference doc
reubenmiller Jan 30, 2024
7a99113
docs: remove title and use te placeholder
reubenmiller Jan 30, 2024
53875d1
docs: rename file transfer service docs
reubenmiller Jan 30, 2024
730cb95
docs: rename cumulocity proxy
reubenmiller Jan 30, 2024
98ad15e
docs: rename software management plugin api
reubenmiller Jan 30, 2024
23729ed
docs: rename supported platforms doc
reubenmiller Jan 30, 2024
17128a0
docs: rename init system configuration doc
reubenmiller Jan 30, 2024
d8665e4
docs: rename build docs
reubenmiller Jan 30, 2024
4520aae
docs: rename extend software management docs
reubenmiller Jan 30, 2024
049eee6
docs: rename vscode dev containers docs
reubenmiller Jan 30, 2024
b358653
docs: rename docker setup instructions
reubenmiller Jan 30, 2024
4d869d7
docs: rename debian package hosting page
reubenmiller Jan 30, 2024
50709f9
docs: remove filename suffix (previously added as git filename detect…
reubenmiller Jan 30, 2024
ea2dffd
docs: add page description
reubenmiller Jan 30, 2024
17a6258
shorten page title
reubenmiller Jan 30, 2024
e599a52
docs: rename package hosting page
reubenmiller Jan 30, 2024
68c4bca
docs: remove sidebar index and use product placeholder
reubenmiller Jan 30, 2024
151bca3
fix broken links
reubenmiller Jan 30, 2024
dd3585f
remove software management section
reubenmiller Jan 30, 2024
bdaabff
docs: use product placeholder
reubenmiller Jan 30, 2024
8eb74b2
docs: use official release channel
reubenmiller Jan 30, 2024
8db5934
docs: use variable to reference to product name
reubenmiller Jan 30, 2024
61598b9
docs: refer to the install guide rather than legacy how to guide
reubenmiller Jan 30, 2024
bcc3f22
docs(apama): drop usage of software type suffix
reubenmiller Jan 30, 2024
bad0578
remove unused front-matter property
reubenmiller Jan 30, 2024
8b092af
rename files to use dashes instead of underscores
reubenmiller Jan 31, 2024
61868f1
rename files to use dashes instead of underscores
reubenmiller Jan 31, 2024
6f9a385
docs: rename send measurements page
reubenmiller Jan 31, 2024
76a0528
docs: adding page descriptions
reubenmiller Jan 31, 2024
28ada64
docs(security): add page descriptions
reubenmiller Jan 31, 2024
ae311ab
docs: add page descriptions
reubenmiller Jan 31, 2024
47280a7
docs: use product name placeholders
reubenmiller Jan 31, 2024
bdf81a9
docs: use official product name in title
reubenmiller Jan 31, 2024
2898db7
docs: use title case for page titles
reubenmiller Jan 31, 2024
b0d97e1
docs: remove h1 header in favour of front matter title
reubenmiller Jan 31, 2024
a6af934
docs: use product name placeholder
reubenmiller Jan 31, 2024
ae210c2
docs: remove unfinished sentence
reubenmiller Jan 31, 2024
f4e5444
fix erroneous sentence
reubenmiller Jan 31, 2024
a00ba9b
docs: use explicit title to emphasis whether it is for static or dyna…
reubenmiller Jan 31, 2024
4ce12ef
docs: add page description to ensure produce placeholder's are resolv…
reubenmiller Jan 31, 2024
3f0ffec
docs: fix troubleshoot typo
reubenmiller Jan 31, 2024
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
32 changes: 16 additions & 16 deletions docs/src/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,13 @@ The following Linux Package Managers are supported out-of-the-box. For all other
<div>
<div class="row">
<div class="column logo">
<img width="80" height="80" src="https://assets.cloudsmith.media/package/images/backends/deb/large.30f93502b7b5.png" alt="Debian logo" />
<em><img width="80" height="80" src="https://assets.cloudsmith.media/package/images/backends/deb/large.30f93502b7b5.png" alt="Debian logo" /></em>
didier-wenzek marked this conversation as resolved.
Show resolved Hide resolved
</div>
<div class="column logo">
<img width="80" height="80" src="https://assets.cloudsmith.media/package/images/backends/rpm/large.f677f5642875.png" alt="RedHat logo" />
<em><img width="80" height="80" src="https://assets.cloudsmith.media/package/images/backends/rpm/large.f677f5642875.png" alt="RedHat logo" /></em>
</div>
<div class="column logo">
<img width="80" height="80" src="https://assets.cloudsmith.media/package/images/backends/alpine/large.974a497e9765.png" alt="Alpine logo" />
<em><img width="80" height="80" src="https://assets.cloudsmith.media/package/images/backends/alpine/large.974a497e9765.png" alt="Alpine logo" /></em>
</div>
</div>
</div>
Expand Down Expand Up @@ -119,31 +119,31 @@ The instructions require you to have the following tools installed.
You will need to have `sudo` also installed if you want to run these instructions.

```sh tab={"label":"Debian/Ubuntu"}
curl -1sLf 'https://dl.cloudsmith.io/public/thinedge/tedge-main/setup.deb.sh' | sudo bash
curl -1sLf 'https://dl.cloudsmith.io/public/thinedge/tedge-release/setup.deb.sh' | sudo bash
```

```sh tab={"label":"RHEL/Fedora/RockyLinux"}
curl -1sLf 'https://dl.cloudsmith.io/public/thinedge/tedge-main/setup.rpm.sh' | sudo bash
curl -1sLf 'https://dl.cloudsmith.io/public/thinedge/tedge-release/setup.rpm.sh' | sudo bash
```

```sh tab={"label":"Alpine"}
curl -1sLf 'https://dl.cloudsmith.io/public/thinedge/tedge-main/setup.alpine.sh' | sudo bash
curl -1sLf 'https://dl.cloudsmith.io/public/thinedge/tedge-release/setup.alpine.sh' | sudo bash
```

**Running as root**

These commands must be run as the root user.

```sh tab={"label":"Debian/Ubuntu"}
curl -1sLf 'https://dl.cloudsmith.io/public/thinedge/tedge-main/setup.deb.sh' | bash
curl -1sLf 'https://dl.cloudsmith.io/public/thinedge/tedge-release/setup.deb.sh' | bash
```

```sh tab={"label":"RHEL/Fedora/RockyLinux"}
curl -1sLf 'https://dl.cloudsmith.io/public/thinedge/tedge-main/setup.rpm.sh' | bash
curl -1sLf 'https://dl.cloudsmith.io/public/thinedge/tedge-release/setup.rpm.sh' | bash
```

```sh tab={"label":"Alpine"}
curl -1sLf 'https://dl.cloudsmith.io/public/thinedge/tedge-main/setup.alpine.sh' | bash
curl -1sLf 'https://dl.cloudsmith.io/public/thinedge/tedge-release/setup.alpine.sh' | bash
```


Expand Down Expand Up @@ -182,7 +182,7 @@ wget -O - https://thin-edge.io/install.sh | sh -s -- --package-manager tarball

## Package repository hosting

[![Hosted By: Cloudsmith](https://img.shields.io/badge/OSS%20hosting%20by-cloudsmith-blue?logo=cloudsmith&style=for-the-badge)](https://cloudsmith.com)
[_![Hosted By: Cloudsmith](https://img.shields.io/badge/OSS%20hosting%20by-cloudsmith-blue?logo=cloudsmith&style=for-the-badge)_](https://cloudsmith.com)

Package repository hosting is graciously provided by [Cloudsmith](https://cloudsmith.com).
Cloudsmith is the only fully hosted, cloud-native, universal package management solution, that
Expand All @@ -198,26 +198,26 @@ The packages can be viewed directly from the [Cloudsmith.io](https://cloudsmith.
</tr>
<tr>
<td>
<img width="24" height="24" src="https://assets.cloudsmith.media/package/images/backends/deb/small.bedd6f749317.png" alt="Debian logo" />
<em><img width="24" height="24" src="https://assets.cloudsmith.media/package/images/backends/deb/small.bedd6f749317.png" alt="Debian logo" /></em>
</td>
<td>
<a href="https://cloudsmith.io/~thinedge/repos/tedge-main/packages/detail/deb/tedge-full/latest/a=all;d=any-distro%252Fany-version;t=binary/"><img src="https://api-prd.cloudsmith.io/v1/badges/version/thinedge/tedge-main/deb/tedge-full/latest/a=all;d=any-distro%252Fany-version;t=binary/?render=true&show_latest=true" alt="Latest version of 'tedge-full' @ Cloudsmith" /></a>
<a href="https://cloudsmith.io/~thinedge/repos/tedge-release/packages/detail/deb/tedge-full/latest/a=all;d=any-distro%252Fany-version;t=binary/"><em><img src="https://api-prd.cloudsmith.io/v1/badges/version/thinedge/tedge-release/deb/tedge-full/latest/a=all;d=any-distro%252Fany-version;t=binary/?render=true&show_latest=true" alt="Latest version of 'tedge-full' @ Cloudsmith" /></em></a>
</td>
</tr>
<tr>
<td>
<img width="24" height="24" src="https://assets.cloudsmith.media/package/images/backends/rpm/small.89bd26d9d17b.png" alt="RedHat logo" />
<em><img width="24" height="24" src="https://assets.cloudsmith.media/package/images/backends/rpm/small.89bd26d9d17b.png" alt="RedHat logo" /></em>
</td>
<td>
<a href="https://cloudsmith.io/~thinedge/repos/tedge-main/packages/detail/rpm/tedge-full/latest/a=noarch;d=any-distro%252Fany-version;t=binary/"><img src="https://api-prd.cloudsmith.io/v1/badges/version/thinedge/tedge-main/rpm/tedge-full/latest/a=noarch;d=any-distro%252Fany-version;t=binary/?render=true&show_latest=true" alt="Latest version of 'tedge-full' @ Cloudsmith" /></a>
<a href="https://cloudsmith.io/~thinedge/repos/tedge-release/packages/detail/rpm/tedge-full/latest/a=noarch;d=any-distro%252Fany-version;t=binary/"><em><img src="https://api-prd.cloudsmith.io/v1/badges/version/thinedge/tedge-release/rpm/tedge-full/latest/a=noarch;d=any-distro%252Fany-version;t=binary/?render=true&show_latest=true" alt="Latest version of 'tedge-full' @ Cloudsmith" /></em></a>
</td>
</tr>
<tr>
<td>
<img width="24" height="24" src="https://assets.cloudsmith.media/package/images/backends/alpine/small.dff9b535ea47.png" alt="Alpine logo" />
<em><img width="24" height="24" src="https://assets.cloudsmith.media/package/images/backends/alpine/small.dff9b535ea47.png" alt="Alpine logo" /></em>
</td>
<td>
<a href="https://cloudsmith.io/~thinedge/repos/tedge-main/packages/detail/alpine/tedge-full/latest/a=noarch;d=alpine%252Fany-version/"><img src="https://api-prd.cloudsmith.io/v1/badges/version/thinedge/tedge-main/alpine/tedge-full/latest/a=noarch;d=alpine%252Fany-version/?render=true&show_latest=true" alt="Latest version of 'tedge-full' @ Cloudsmith" /></a>
<a href="https://cloudsmith.io/~thinedge/repos/tedge-release/packages/detail/alpine/tedge-full/latest/a=noarch;d=alpine%252Fany-version/"><em><img src="https://api-prd.cloudsmith.io/v1/badges/version/thinedge/tedge-release/alpine/tedge-full/latest/a=noarch;d=alpine%252Fany-version/?render=true&show_latest=true" alt="Latest version of 'tedge-full' @ Cloudsmith" /></em></a>
</td>
</tr>
</table>