mirror of https://github.com/dapr/docs.git
Merge branch 'v1.7' into v1.7
This commit is contained in:
greenie-msft
GitHub
commit
5784ad2046
|
|
@ -19,7 +19,6 @@ Fork the [docs repository](https://github.com/dapr/docs) to work on any changes
|
|||
Follow the instructions in the repository [README.md](https://github.com/dapr/docs/blob/master/README.md#environment-setup) to install Hugo locally and build the docs website.
|
||||
|
||||
## Branch guidance
|
||||
|
||||
The Dapr docs handles branching differently than most code repositories. Instead of having a `master` or `main` branch, every branch is labeled to match the major and minor version of a runtime release. For the full list visit the [Docs repo](https://github.com/dapr/docs#branch-guidance)
|
||||
|
||||
Overall, all updates should go into the docs branch for the latest release of Dapr. You can find this directly at [https://github.com/dapr/docs](https://github.com/dapr/docs), as the latest release will be the default branch. For any docs changes that are applicable to a release candidate or a pre-release version of the docs, make your changes into that particular branch.
|
||||
|
|
@ -36,6 +35,16 @@ These conventions should be followed throughout all Dapr documentation to ensure
|
|||
- **Assume a new developer audience** - Some obvious steps can seem hard. E.g. Now set an environment variable Dapr to a value X. It is better to give the reader the explicit command to do this, rather than having them figure this out.
|
||||
- **Use present tense** - Avoid sentences like "this command will install redis", which implies the action is in the future. Instead use "This command installs redis" which is in the present tense.
|
||||
|
||||
## Diagrams and images
|
||||
It is strongly encouraged to create diagrams and images where ever possible for documentation pages. All diagrams are kept in a [Dapr Diagrams Deck](/images/dapr-diagrams.pptx) which has guidance on style and icons. The diagram images are saved as PNG files into the [images folder](/images).
|
||||
Diagrams should be;
|
||||
- Saved as PNG files with a high resolution
|
||||
- Named using the convention of a concept or building block so that they are grouped. For example `service-invocation-overview.png`. Also see Images guidance section below.
|
||||
- Added to the correct section in the `Dapr-Diagrams.pptx` deck so that they can be amended and updated.
|
||||
|
||||
{{< button text="Download the Dapr Diagrams Deck" link="/images/dapr-diagrams.pptx" >}}
|
||||
|
||||
|
||||
## Contributing a new docs page
|
||||
- Make sure the documentation you are writing is in the correct place in the hierarchy.
|
||||
- Avoid creating new sections where possible, there is a good chance a proper place in the docs hierarchy already exists.
|
||||
|
|
@ -50,7 +59,6 @@ These conventions should be followed throughout all Dapr documentation to ensure
|
|||
- Where possible reference a practical How-To doc.
|
||||
|
||||
### Contributing a new How-To guide
|
||||
|
||||
- `How To` articles are meant to provide step-by-step practical guidance on to readers who wish to enable a feature, integrate a technology or use Dapr in a specific scenario.
|
||||
- Sub directory naming - the directory name should be descriptive and if referring to specific component or concept should begin with the relevant name. Example *pubsub-namespaces*.
|
||||
- Do not assume the reader is using a specific environment unless the article itself is specific to an environment. This include OS (Windows/Linux/MacOS), deployment target (Kubernetes, IoT etc.) or programming language. If instructions vary between operating systems, provide guidance for all.
|
||||
|
|
|
|||
|
|
@ -21,14 +21,28 @@ dapr components [flags]
|
|||
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------------- | -------------------- | ------- | ------------------------------------------------ |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr components in a Kubernetes cluster |
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr components in a Kubernetes cluster (required) |
|
||||
| `--all-namespaces`, `-A` | | `true` | If true, list all Dapr components in all namespaces |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--name`, `-n` | | | The components name to be printed (optional) |
|
||||
| `--namespace` | | | List all components in the specified namespace |
|
||||
| `--output`, `-o` | | `list` | Output format (options: json or yaml or list) |
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# List Kubernetes components
|
||||
# List Dapr components in all namespaces in Kubernetes mode
|
||||
dapr components -k
|
||||
```
|
||||
|
||||
# List Dapr components in specific namespace in Kubernetes mode
|
||||
dapr components -k --namespace default
|
||||
|
||||
# Print specific Dapr component in Kubernetes mode
|
||||
dapr components -k -n mycomponent
|
||||
|
||||
# List Dapr components in all namespaces in Kubernetes mode
|
||||
dapr components -k --all-namespaces
|
||||
```
|
||||
|
|
@ -21,16 +21,28 @@ dapr configurations [flags]
|
|||
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------------- | -------------------- | ------- | ---------------------------------------------------- |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr configurations in a Kubernetes cluster |
|
||||
| `--name`, `-n` | | | The configuration name to be printed (optional) |
|
||||
| `--output`, `-o` | | `list` | Output format (options: json or yaml or list) |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr configurations in Kubernetes cluster (required).
|
||||
| `--all-namespaces`, `-A` | | `true` | If true, list all Dapr configurations in all namespaces (optional)
|
||||
| `--namespace` | | | List Dapr configurations in specific namespace.
|
||||
| `--name`, `-n` | | | Print specific Dapr configuration. (optional)
|
||||
| `--output`, `-o` | | `list`| Output format (options: json or yaml or list)
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# List Kubernetes Dapr configurations
|
||||
# List Dapr configurations in all namespaces in Kubernetes mode
|
||||
dapr configurations -k
|
||||
```
|
||||
|
||||
# List Dapr configurations in specific namespace in Kubernetes mode
|
||||
dapr configurations -k --namespace default
|
||||
|
||||
# Print specific Dapr configuration in Kubernetes mode
|
||||
dapr configurations -k -n appconfig
|
||||
|
||||
# List Dapr configurations in all namespaces in Kubernetes mode
|
||||
dapr configurations -k --all-namespaces
|
||||
```
|
||||
|
|
@ -22,11 +22,14 @@ dapr list [flags]
|
|||
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------------- | -------------------- | ------- | --------------------------------------------------------------------------- |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr pods in a Kubernetes cluster |
|
||||
| `--output`, `-o` | | `table` | The output format of the list. Valid values are: `json`, `yaml`, or `table` |
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--all-namespaces`, `-A` | | `false` | List all Dapr pods in all namespaces (optional) |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr pods in a Kubernetes cluster (optional) |
|
||||
| `--namespace`, `-n` | | `default` | List the Dapr pods in the defined namespace in Kubernetes. Only with `-k` flag (optional) |
|
||||
| `--output`, `-o` | | `table` | The output format of the list. Valid values are: `json`, `yaml`, or `table`
|
||||
|
||||
### Examples
|
||||
|
||||
|
|
@ -34,9 +37,15 @@ dapr list [flags]
|
|||
# List Dapr instances in self-hosted mode
|
||||
dapr list
|
||||
|
||||
# List Dapr instances in Kubernetes mode
|
||||
# List Dapr instances in all namespaces in Kubernetes mode
|
||||
dapr list -k
|
||||
|
||||
# List Dapr instances in JSON format
|
||||
dapr list -o json
|
||||
```
|
||||
|
||||
# List Dapr instances in a specific namespace in Kubernetes mode
|
||||
dapr list -k --namespace default
|
||||
|
||||
# List Dapr instances in all namespaces in Kubernetes mode
|
||||
dapr list -k --all-namespaces
|
||||
```
|
||||
Binary file not shown.
Loading…
Reference in New Issue