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

Improve documentation #2

Open
6 of 9 tasks
stephlocke opened this issue Apr 24, 2024 · 0 comments
Open
6 of 9 tasks

Improve documentation #2

stephlocke opened this issue Apr 24, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@stephlocke
Copy link
Collaborator

stephlocke commented Apr 24, 2024

  • Include goal and architecture
  • Update deployment instructions to have a "Deploy to Azure" button and/or az cli instructions
  • Create documentation for developing the Power BI report
  • Add an intro to the application modernisation tools being used in docs/appcat.md
  • Describe the architecture and design decisions made in docs/architecture.md
  • Write a how-to guide for developing Functions locally (balance single place of info with relying on Learn docs to ensure info is up to date) in docs/developing_functions_locally.md
  • Describe the security best practices used within the solution in docs/security_and_authentication.md
  • Write a quickstart guide to getting this solution up and running in docs/getting-started.md
  • Have the docs publishing to make a nice docs site
@stephlocke stephlocke added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Apr 24, 2024
@stephlocke stephlocke changed the title Improve README Improve documentation May 10, 2024
@stephlocke stephlocke pinned this issue May 10, 2024
@stephlocke stephlocke added the good first issue Good for newcomers label May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant