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

Update contributing Guide #4396

Merged
merged 5 commits into from
Nov 1, 2024
Merged

Update contributing Guide #4396

merged 5 commits into from
Nov 1, 2024

Conversation

hhunter-ms
Copy link
Collaborator

Description

Updates to the contributing guide re: new diagram process
Link to quickstart contributing guide in quickstart repo

Issue reference

PR will close: #4395

Signed-off-by: Hannah Hunter <[email protected]>
@hhunter-ms hhunter-ms self-assigned this Oct 21, 2024
@hhunter-ms hhunter-ms changed the title update contributing guide pt 1 Update contributing Guide Oct 21, 2024
@hhunter-ms hhunter-ms marked this pull request as ready for review October 23, 2024 13:43
@hhunter-ms hhunter-ms requested review from a team as code owners October 23, 2024 13:43
Copy link

Stale PR, paging all reviewers

@github-actions github-actions bot added the stale label Oct 29, 2024
@hhunter-ms hhunter-ms removed the stale label Oct 29, 2024

- 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any way that we can have the URL here be dynamic, otherwise this will need to be updated on each release. If not, then can keep this for now, but it will eventually go stale.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am referring to the v1.14 in the URL and whether this can use the latest tag? Have we done this anywhere else?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we have... I can do a quick search though.

- 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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

Copy link
Member

@msfussell msfussell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@hhunter-ms hhunter-ms merged commit 2adc441 into dapr:v1.14 Nov 1, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Updates to contributing guide
2 participants