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.

Sign up for GitHub

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

Jump to bottom

Unify Sample's readme template #26

Closed
Tracked by #32
backwind1233 opened this issue Aug 10, 2021 · 2 comments
Closed
Tracked by #32

Unify Sample's readme template #26

backwind1233 opened this issue Aug 10, 2021 · 2 comments
Labels
azure-spring All azure-spring related issues azure-spring-samples Issues related to Spring Cloud Azure samples. client feature-request This issue requires a new behavior in the product in order be resolved.
Milestone
[2021] November

Comments

@backwind1233
Copy link
Contributor

backwind1233 commented Aug 10, 2021 •
edited
Loading

Each Sample in this repo should share one common structure or template ,eg: readme
Eg: Readme Structure

  • Goal
  • Key concepts
  • How to config
    • connectionString
    • service principal
      • Access control (IAM) :assign role
    • msi
  • configurable parameters
  • Running locally
  • deployment
    • Deploy to Azure Spring Cloud
@backwind1233 backwind1233 added the azure-spring All azure-spring related issues label Aug 10, 2021
@backwind1233 backwind1233 self-assigned this Aug 10, 2021
@chenrujun
Copy link

And the readme in the service / artifact-id level should be more tutorial like.
One tutorial can include multiple sample applications.
Just like this one: https://spring.io/guides/tutorials/spring-boot-oauth2/

@backwind1233 backwind1233 added this to the Backlog milestone Aug 11, 2021
@backwind1233 backwind1233 changed the title Unify Sample's template Unify Sample's readme template Aug 16, 2021
@backwind1233 backwind1233 mentioned this issue Aug 16, 2021
Open
14 tasks
@backwind1233 backwind1233 modified the milestones: Backlog, [2021] October Sep 2, 2021
@backwind1233
Copy link
Contributor Author

Closing this issue, duplicated with #149

@backwind1233 backwind1233 added client azure-spring-samples Issues related to Spring Cloud Azure samples. feature-request This issue requires a new behavior in the product in order be resolved. labels Apr 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
azure-spring All azure-spring related issues azure-spring-samples Issues related to Spring Cloud Azure samples. client feature-request This issue requires a new behavior in the product in order be resolved.
Projects
None yet
Milestone
[2021] November
Development

No branches or pull requests
2 participants
@backwind1233 @chenrujun