Skip to content

Commit 4aabcec

Browse files
ref: convert documentation from README.rst to GitHub Wiki (#495)
## 📝 Description **What does this PR do and why is this change necessary?** All information from the `README.rst` file has been moved to the [Wiki](https://github.com/linode/linode-cli/wiki) adding a simple `README.md` to push people to the Wiki, please leave any feedback about the wiki here as well. Co-authored-by: Lena Garber <[email protected]>
1 parent c733c86 commit 4aabcec

File tree

12 files changed

+511
-520
lines changed

12 files changed

+511
-520
lines changed

.github/workflows/publish-wiki.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Publish Wiki
2+
3+
on:
4+
push:
5+
branches: [main]
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v3
12+
13+
- name: Generate App Installation Token
14+
id: generate_token
15+
uses: tibdex/github-app-token@b62528385c34dbc9f38e5f4225ac829252d1ea92 # pin@v1
16+
with:
17+
app_id: ${{ secrets.CLI_RELEASE_APP_ID }}
18+
private_key: ${{ secrets.CLI_RELEASE_PRIVATE_KEY }}
19+
repository: linode/linode-cli
20+
21+
- name: Upload Documentation to Wiki
22+
uses: SwiftDocOrg/github-wiki-publish-action@v1
23+
with:
24+
path: "wiki"
25+
env:
26+
GH_PERSONAL_ACCESS_TOKEN: ${{ steps.generate_token.outputs.token }}

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# linode-cli (lin)
2+
3+
The Linode Command Line Interface
4+
5+
Provides easy access to any of the Linode API endpoints from the command line and displays results in an organized, configurable table.
6+
7+
This project is automatically generated from the [Linode OpenAPI spec](https://www.linode.com/docs/api/) using the [openapi3 Python package](https://github.com/Dorthu/openapi3).
8+
9+
![Example of CLI in use](https://raw.githubusercontent.com/linode/linode-cli/main/demo.gif)
10+
11+
Visit the [Wiki](../../wiki) for more information.
12+
13+
## Install
14+
15+
Install via PyPI:
16+
```bash
17+
pip3 install linode-cli
18+
```
19+
20+
Visit the [Wiki](../../wiki/Installation) for more information.
21+
22+
## Contributing
23+
24+
This CLI is generated from the [OpenAPI specification for Linode's API](https://github.com/linode/linode-api-docs). As
25+
such, many changes are made directly to the spec.
26+
27+
Please follow the [Contributing Guidelines](https://github.com/linode/linode-cli/blob/main/CONTRIBUTING.md) when making a contribution.

0 commit comments

Comments
 (0)