diff --git a/daprdocs/content/en/contributing/contributing-overview.md b/daprdocs/content/en/contributing/contributing-overview.md index 4e84c5071..b78669994 100644 --- a/daprdocs/content/en/contributing/contributing-overview.md +++ b/daprdocs/content/en/contributing/contributing-overview.md @@ -18,7 +18,7 @@ See the [Dapr community repository](https://github.com/dapr/community) for more 1. **Docs**: This [repository](https://github.com/dapr/docs) contains the documentation for Dapr. You can contribute by updating existing documentation, fixing errors, or adding new content to improve user experience and clarity. Please see the specific guidelines for [docs contributions]({{< ref contributing-docs >}}). -2. **Quickstarts**: The Quickstarts [repository](https://github.com/dapr/quickstarts) provides simple, step-by-step guides to help users get started with Dapr quickly. Contributions in this repository involve creating new quickstarts, improving existing ones, or ensuring they stay up-to-date with the latest features. +2. **Quickstarts**: The Quickstarts [repository](https://github.com/dapr/quickstarts) provides simple, step-by-step guides to help users get started with Dapr quickly. [Contributions in this repository](https://github.com/dapr/quickstarts/blob/master/CONTRIBUTING.md) involve creating new quickstarts, improving existing ones, or ensuring they stay up-to-date with the latest features. 3. **Runtime**: The Dapr runtime [repository](https://github.com/dapr/dapr) houses the core runtime components. Here, you can contribute by fixing bugs, optimizing performance, implementing new features, or enhancing existing ones. diff --git a/daprdocs/content/en/contributing/daprbot.md b/daprdocs/content/en/contributing/daprbot.md index 2e35fd491..b4b53d0bf 100644 --- a/daprdocs/content/en/contributing/daprbot.md +++ b/daprdocs/content/en/contributing/daprbot.md @@ -2,7 +2,7 @@ type: docs title: "Dapr bot reference" linkTitle: "Dapr bot" -weight: 15 +weight: 70 description: "List of Dapr bot capabilities." --- diff --git a/daprdocs/content/en/contributing/docs-contrib/contributing-docs.md b/daprdocs/content/en/contributing/docs-contrib/contributing-docs.md index 2ed1f81bd..a76b02344 100644 --- a/daprdocs/content/en/contributing/docs-contrib/contributing-docs.md +++ b/daprdocs/content/en/contributing/docs-contrib/contributing-docs.md @@ -41,15 +41,18 @@ Style and tone conventions should be followed throughout all Dapr documentation ## Diagrams and images -Diagrams and images are invaluable visual aids for documentation pages. Diagrams are kept in a [Dapr Diagrams Deck](https://github.com/dapr/docs/tree/v1.11/daprdocs/static/presentations), which includes guidance on style and icons. +Diagrams and images are invaluable visual aids for documentation pages. Use the diagram style and icons in the [Dapr Diagrams template deck](https://github.com/dapr/docs/tree/v1.14/daprdocs/static/presentations). -As you create diagrams for your documentation: +The process for creating diagrams for your documentation: -- Save them as high-res PNG files into the [images folder](https://github.com/dapr/docs/tree/v1.11/daprdocs/static/images). -- Name your PNG files using the convention of a concept or building block so that they are grouped. +1. Download the [Dapr Diagrams template deck](https://github.com/dapr/docs/tree/v1.14/daprdocs/static/presentations) to use the icons and colors. +1. Add a new slide and create your diagram. +1. Screen capture the diagram as high-res PNG file and save in the [images folder](https://github.com/dapr/docs/tree/v1.14/daprdocs/static/images). +1. Name your PNG files using the convention of a concept or building block so that they are grouped. - For example: `service-invocation-overview.png`. - For more information on calling out images using shortcode, see the [Images guidance](#images) section below. -- Add the diagram to the correct section in the `Dapr-Diagrams.pptx` deck so that they can be amended and updated during routine refresh. +1. Add the diagram to the appropriate section in your documentation using the HTML `` tag. +1. In your PR, comment the diagram slide (not the screen capture) so it can be reviewed and added to the diagram deck by maintainers. ## Contributing a new docs page diff --git a/daprdocs/static/presentations/Dapr-Diagrams-template.pptx.zip b/daprdocs/static/presentations/Dapr-Diagrams-template.pptx.zip new file mode 100644 index 000000000..3a871010f Binary files /dev/null and b/daprdocs/static/presentations/Dapr-Diagrams-template.pptx.zip differ diff --git a/daprdocs/static/presentations/Dapr-Diagrams.pptx.zip b/daprdocs/static/presentations/Dapr-Diagrams.pptx.zip deleted file mode 100644 index 206d01600..000000000 Binary files a/daprdocs/static/presentations/Dapr-Diagrams.pptx.zip and /dev/null differ