Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions .github/ISSUE_TEMPLATE/-internal-only--release-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,9 @@ Status icons:
- [ ] Confirm all tests pass: `<root>/src/scripts/Test-PowerShell.ps1 -Unit -Integration -Build`.
- [ ] Confirm if all features are code complete and not missing any functionality required for release.
> _Once in `dev`, the feature is considered part of the next release and can be pushed out at any time. Any broken features will be reverted._
- [ ] Confirm new or updated functionality is documented in the [changelog](https://github.com/microsoft/finops-toolkit/blob/dev/docs/changelog.md).
> _See [Changelog guidance](#-changelog-guidance) for details about changelog requirements._
- [ ] Confirm new or updated functionality is documented in the [changelog](https://github.com/microsoft/finops-toolkit/blob/dev/docs-mslearn/toolkit/changelog.md).
- [ ] Confirm new or updated functionality must be documented in the [documentation](https://github.com/microsoft/finops-toolkit/blob/dev/docs).
- [ ] If adding a new tool, update the [list of available tools](https://github.com/microsoft/finops-toolkit/tree/dev/docs#-available-tools) on the documentation home page.
- [ ] If adding a new tool, update the [list of available tools](https://aka.ms/finops/toolkit#available-tools) on the documentation home page.
- [ ] Merge any feature branches that are ready to `dev`.
- [ ] Create a PR to merge the feature branch into `dev`.
- [ ] Follow the normal PR process to merge the PR.
Expand All @@ -83,7 +82,7 @@ Status icons:

## πŸ”œ Finalize release

- [ ] Review the [changelog](../docs/_resources/changelog.md) to ensure it encapsulates all changes.
- [ ] Review the [changelog](https://github.com/microsoft/finops-toolkit/blob/dev/docs-mslearn/toolkit/changelog.md) to ensure it encapsulates all changes.
- Move all released changes to an official numbered version section.
- If there are committed changes in a feature branch that you want to mention, add them to an "Unreleased" section.
- [ ] Update the version.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The FinOps toolkit is an open-source collection of customizable tools and resour
- Advanced solutions to facilitate building custom capabilities.
- Learning resources and best practices about how to implement FinOps.

[🧰 Learn about the tools](https://aka.ms/finops/toolkit#-available-tools)
[🧰 Learn about the tools](https://aka.ms/finops/toolkit#available-tools)

<br>

Expand Down
2 changes: 1 addition & 1 deletion docs-wiki/About.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To empower organizations to quantify and maximize the value they get from the Mi

The FinOps toolkit is a labor of love from passionate people across the globe both inside and outside of Microsoft. There are many ways to contribute from feedback and discussions to submitting and reviewing documentation updates and code changes. We value any contribution, regardless of its size.

To learn more, refer to our [contribution guide](https://github.com/microsoft/finops-toolkit/blob/dev/CONTRIBUTING.md)
To learn more, refer to our [contribution guide](../tree/dev/CONTRIBUTING.md)

<br>

Expand Down
8 changes: 4 additions & 4 deletions docs-wiki/Branching-strategy.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- markdownlint-disable MD041 -->

- [main](https://github.com/microsoft/finops-toolkit/tree/main) includes the latest stable release.
- [dev](https://github.com/microsoft/finops-toolkit/tree/dev) includes the latest changes that will go into the next release.
- [main](../tree/main) includes the latest stable release.
- [dev](../tree/dev) includes the latest changes that will go into the next release.
- Feature branches (`features/<feature-name>`) are used for any in-progress features that are not yet ready for release.
- Personal branches (`<your-github-account>/<feature-name>`) are intended for a single developer and typically not shared. Use these for small changes that can easily be integrated into the next release.

Expand Down Expand Up @@ -35,7 +35,7 @@ On this page:
- `dev` is for the next release. All PRs to this branch must meet the following requirements:
- Changes must be complete and validated. No partial commits.
- Applicable documentation in [docs](../tree/dev/docs) must be updated.
- External-facing changes must be covered in the [changelog](../tree/dev/docs/changelog.md).
- External-facing changes must be covered in the [changelog](../tree/dev/docs-mslearn/toolkit/changelog.md).
- `features/workbookv2` is for the Cost optimization workbook's next release. Target version: `0.1` (TBD).
- `features/governance` is for a new Governance workbook. Target version: `0.1` (TBD).
- `features/powershell` is for PowerShell automation. Target version: `0.1.*`.
Expand All @@ -53,7 +53,7 @@ If contributing to an in-progress feature, switch to the feature branch and subm

If contributing a new feature, switch to the `dev` branch and submit a PR back to the main repo's `dev` branch. You are free to invite others to contribute within your fork as needed.

If you run into any issues, please reach out to us on [Discussions](https://github.com/microsoft/finops-toolkit/discussions). We're happy to help!
If you run into any issues, please reach out to us on [Discussions](../discussions). We're happy to help!

<br>

Expand Down
12 changes: 6 additions & 6 deletions docs-wiki/Build-and-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ cd "<repo-root>"
src/scripts/Build-Toolkit "<template-name>"
```

To build all templates and modules, simply remove the template name or run `npm run build`, if you have NPM setup. To learn more about the build script, see [Build-Toolkit](https://github.com/microsoft/finops-toolkit/blob/dev/src/scripts/README.md#-build-toolkit).
To build all templates and modules, simply remove the template name or run `npm run build`, if you have NPM setup. To learn more about the build script, see [Build-Toolkit](../tree/dev/src/scripts/README.md#-build-toolkit).

To build and deploy templates, run:

Expand All @@ -41,9 +41,9 @@ cd "<repo-root>"
src/scripts/Deploy-Toolkit "<template-name>" -Build
```

For more local deployment options, see [Deploy-Toolkit](https://github.com/microsoft/finops-toolkit/blob/dev/src/scripts/README.md#-deploy-toolkit).
For more local deployment options, see [Deploy-Toolkit](../tree/dev/src/scripts/README.md#-deploy-toolkit).

To learn more, see [FinOps toolkit templates](https://github.com/microsoft/finops-toolkit/blob/dev/src/templates/README.md).
To learn more, see [FinOps toolkit templates](../tree/dev/src/templates/README.md).

### Building workbooks

Expand All @@ -65,7 +65,7 @@ src/scripts/Deploy-Toolkit "<workbook-name>-workbook" -Build

The Build-Toolkit script calls an internal Build-Workbook script, which does all the work. You can also call this directly; however, we recommend running the Build-Toolkit script for a complete build process.

To learn more, see [Workbook modules](https://github.com/microsoft/finops-toolkit/blob/dev/src/workbooks/README.md).
To learn more, see [Workbook modules](../tree/dev/src/workbooks/README.md).

### Building Bicep Registry modules

Expand All @@ -92,7 +92,7 @@ cd "<repo-root>"
src/scripts/Deploy-Toolkit "<module-name>" -Build -Test
```

To learn more, see [Bicep Registry modules](https://github.com/microsoft/finops-toolkit/blob/dev/src/bicep-registry/README.md).
To learn more, see [Bicep Registry modules](../tree/dev/src/bicep-registry/README.md).

### Building open data files

Expand All @@ -104,7 +104,7 @@ To build open data, run:
src/Build-OpenData
```

To learn more about open data, see [Open data](https://github.com/microsoft/finops-toolkit/blob/dev/src/open-data/README.md).
To learn more about open data, see [Open data](../tree/dev/src/open-data/README.md).

### Building PowerShell

Expand Down
8 changes: 4 additions & 4 deletions docs-wiki/Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

- Every folder has a README that explains its purpose.
- If you want to know how to deploy a FinOps toolkit solution, start with the [documentation](https://aka.ms/finops/toolkit).
- If you want to know how you can contribute, check out the [contribution guide](https://github.com/microsoft/finops-toolkit/tree/dev/CONTRIBUTING.md).
- If you want to get started with the code, start in the [wiki](https://github.com/microsoft/finops-toolkit/wiki). &nbsp; **← YOU ARE HERE**
- If you want to know how you can contribute, check out the [contribution guide](../tree/dev/CONTRIBUTING.md).
- If you want to get started with the code, start in the [wiki](../wiki). &nbsp; **← YOU ARE HERE**
- Read about our [[Architecture]] for context on technologies and structure.
- Review our [[Coding guidelines]] before you write/review code.
- Review the guidance below for how to contribute code.
- When you're ready to dig into code, you'll check the [src](https://github.com/microsoft/finops-toolkit/tree/dev/src) folder.
- When you're ready to dig into code, you'll check the [src](../tree/dev/src) folder.

<br>

Expand All @@ -27,7 +27,7 @@ On this page:

## πŸ›« Get started

There are many ways to contribute to the FinOps toolkit project, like reporting issues, suggesting features, and submitting or reviewing pull requests. For an overview, refer to the [contribution guide](../CONTRIBUTING.md). This page covers how to contribute to the code.
There are many ways to contribute to the FinOps toolkit project, like reporting issues, suggesting features, and submitting or reviewing pull requests. For an overview, refer to the [contribution guide](../tree/dev/CONTRIBUTING.md). This page covers how to contribute to the code.

After cloning and building the repo, check out the [issues list](../issues):

Expand Down
14 changes: 7 additions & 7 deletions docs-wiki/Release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ When a feature branch is code-complete, it can be merged into `dev`. Before proc
> _The PR will be blocked if they don't._
2. Any new features are code complete and not missing any functionality required for release.
> _Once in `dev`, the feature is considered part of the next release and can be pushed out at any time. Any broken features will be reverted._
3. All new or updated functionality must be documented in the [changelog](https://github.com/microsoft/finops-toolkit/blob/dev/docs/changelog.md).
3. All new or updated functionality must be documented in the [changelog](../tree/dev/docs-mslearn/toolkit/changelog.md).
> _See [Changelog guidance](#-changelog-guidance) for details about changelog requirements._
4. All new or updated functionality must be documented in the [documentation](https://github.com/microsoft/finops-toolkit/blob/dev/docs).
5. Update the [list of available tools](https://github.com/microsoft/finops-toolkit/tree/dev/docs#-available-tools) on the documentation home page.
4. All new or updated functionality must be documented in the [documentation](../tree/dev/docs).
5. Update the [list of available tools](https://aka.ms/finops/toolkit#available-tools) on the documentation home page.

Once the above requirements have been met, the feature branch can be merged into `dev` using the following steps:

Expand All @@ -34,7 +34,7 @@ Once the above requirements have been met, the feature branch can be merged into

## πŸš€ Publishing an official release

1. Review the [changelog](../docs/_resources/changelog.md) to ensure it encapsulates all changes.
1. Review the [changelog](../tree/dev/docs-mslearn/toolkit/changelog.md) to ensure it encapsulates all changes.
- Move all released changes to an official numbered version section.
- If there are committed changes in a feature branch that you want to mention, add them to an "Unreleased" section.
2. Update the version.
Expand Down Expand Up @@ -86,7 +86,7 @@ Once the above requirements have been met, the feature branch can be merged into

5. Finalize the release.

1. Update the [milestone](https://github.com/microsoft/finops-toolkit/milestones).
1. Update the [milestone](../milestones).

1. Review all issues in the milestone, move anything that needs to be pushed, and close any completed items.
2. Close the milestone when all issues have been closed or moved.
Expand Down Expand Up @@ -119,7 +119,7 @@ Once the above requirements have been met, the feature branch can be merged into

5. Verify [documentation](https://aka.ms/finops/toolkit) updated correctly.

> _The documentation site may take 5 minutes to update after the merge is committed. If not updated, look at [GitHub actions](https://github.com/microsoft/finops-toolkit/actions/workflows/pages/pages-build-deployment) to see if there are any failures._
> _The documentation site may take 5 minutes to update after the merge is committed. If not updated, look at [GitHub actions](../actions/workflows/pages/pages-build-deployment) to see if there are any failures._

6. Run `Package-Toolkit -Build -PowerBI` script.
- For each Power BI report:
Expand All @@ -136,7 +136,7 @@ Once the above requirements have been met, the feature branch can be merged into
6. Save PBIX again in the release folder.
> ⚠️ _**DO NOT** save the above changes back to the Power BI project files!_
7. Copy the first paragraph from the **Get started** page and export a template (PBIT file) in the release folder. Use the copied text for the description and add "Learn more at https://aka.ms/ftk/{report-name}" as a separate paragraph in the description.
7. Tag and publish a [new release](https://github.com/microsoft/finops-toolkit/releases/new):
7. Tag and publish a [new release](../releases/new):
1. Create a tag on publish using the "vX.X" format.
2. Set the **Target** to `main`.
3. Set the **Previous tag** to the previous release tag.
Expand Down
4 changes: 2 additions & 2 deletions docs-wiki/Support-escalations.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Tools and resources within the FinOps toolkit are provided as-is without any exp

If you run into an issue, we recommend taking the following actions:

1. **Report security issues securely.**<br>If you believe you've found a security vulnerability, refer to [Reporting security issues](https://github.com/microsoft/finops-toolkit/blob/dev/SECURITY.md).<br>&nbsp;
1. **Report security issues securely.**<br>If you believe you've found a security vulnerability, refer to [Reporting security issues](../tree/dev/SECURITY.md).<br>&nbsp;
2. **Confirm all setup instructions were completed in order.**<br>9 out of 10 issues are due to missing steps. Please follow instructions carefully.<br>&nbsp;
3. **Review the [troubleshooting guide](https://aka.ms/ftk/trouble).**<br>The most common issues and their solutions are documented and should be able to be resolved indepdentently.<br>&nbsp;
4. **Identify the source of the issue.**<br>For error messages, what product is showing the error? Does the error refer to another product? For missing or incorrect data, is the data generated in Power BI report or does it come directly from a product, like Cost Management?<br>&nbsp;
5. **Create support requests for product issues.**<br>If the source of the issue is a managed product (including data from Cost Management), create a Microsoft support request for that specific product. If you're not sure, ask in the [Q&A discussion forum](https://github.com/microsoft/finops-toolkit/discussions/categories/q-a).<br>&nbsp;
5. **Create support requests for product issues.**<br>If the source of the issue is a managed product (including data from Cost Management), create a Microsoft support request for that specific product. If you're not sure, ask in the [Q&A discussion forum](../discussions/categories/q-a).<br>&nbsp;
6. **Create an issue in GitHub.**<br>Whether you submit a support request or not, we recommend [creating an issue](https://aka.ms/ftk/idea) to let us know about the problems you're facing. Even if the issue is a product bug, we would like to document it to help others.

We try to respond to issues and discussions within 2 business days but there can sometimes be unanticipated delays. If you've completed all steps above and the issue has not been resolved within a week, we should set up a Teams call for you to share your screen so we can troubleshoot the issue together.
Expand Down
4 changes: 2 additions & 2 deletions docs-wiki/_Footer.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- markdownlint-disable MD041 -->

Have a question or suggestion? [Start a discussion](https://github.com/microsoft/finops-toolkit/discussions/new?category=general) and let us know you think.
Have a question or suggestion? [Start a discussion](../discussions/new?category=general) and let us know you think.

Find a doc bug? [Update docs-wiki](https://github.com/microsoft/finops-toolkit/tree/dev/docs-wiki) and submit a PR.
Find a doc bug? [Update docs-wiki](../tree/dev/docs-wiki) and submit a PR.
29 changes: 15 additions & 14 deletions docs-wiki/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,21 @@ On this page:

## πŸ“‚ Folder structure

| Name | Description |
| -------------------------------------------------------------------- | -------------------------------- |
| [docs](../docs) | Public-facing toolkit docs. |
| [docs-wiki](../docs-wiki) | Repo wiki for internal dev docs. |
| [src](../src) | Source code and dev docs. |
| β”œβ”€ [bicep-registry](../src/bicep-registry) | Bicep registry modules. |
| β”œβ”€ [open-data](../src/open-data) | Open data. |
| β”œβ”€ [power-bi](../src/power-bi) | Power BI reports. |
| β”œβ”€ [powershell](../src/powershell) | PowerShell module functions. |
| β”œβ”€ [templates](../src/templates) | ARM deployment templates. |
| β”‚ &nbsp;&nbsp; └─ [finops-hub](../src/templates/finops-hub) | FinOps hub template. |
| └─ [workbooks](../src/workbooks) | Azure Monitor workbooks. |
| &nbsp; &nbsp;&nbsp; β”œβ”€ [governance](../src/templates/governance) | Governance workbook. |
| &nbsp; &nbsp;&nbsp; └─ [optimization](../src/templates/optimization) | Optimization workbook. |
| Name | Description |
| ----------------------------------------------------------------------------- | -------------------------------- |
| [docs](../tree/dev/docs) | Public-facing toolkit docs. |
| [docs-mslearn](../tree/dev/docs-mslearn) | Public-facing docs on mslearn. |
| [docs-wiki](../tree/dev/docs-wiki) | Repo wiki for internal dev docs. |
| [src](../tree/dev/src) | Source code and dev docs. |
| β”œβ”€ [bicep-registry](../tree/dev/src/bicep-registry) | Bicep registry modules. |
| β”œβ”€ [open-data](../tree/dev/src/open-data) | Open data. |
| β”œβ”€ [power-bi](../tree/dev/src/power-bi) | Power BI reports. |
| β”œβ”€ [powershell](../tree/dev/src/powershell) | PowerShell module functions. |
| β”œβ”€ [templates](../tree/dev/src/templates) | ARM deployment templates. |
| β”‚ &nbsp;&nbsp; └─ [finops-hub](../tree/dev/src/templates/finops-hub) | FinOps hub template. |
| └─ [workbooks](../tree/dev/src/workbooks) | Azure Monitor workbooks. |
| &nbsp; &nbsp;&nbsp; β”œβ”€ [governance](../tree/dev/src/workbooks/governance) | Governance workbook. |
| &nbsp; &nbsp;&nbsp; └─ [optimization](../tree/dev/src/workbooks/optimization) | Optimization workbook. |

Files and folders should use kebab casing (for example, `this-is-my-folder`). The only exception is for RP namespaces in module paths.

Expand Down