Skip to content

Commit

Permalink
Integrate Arthur's TSG into existing docs (#815)
Browse files Browse the repository at this point in the history
  • Loading branch information
flanakin authored Jul 12, 2024
1 parent 420d9d1 commit 0fc7770
Show file tree
Hide file tree
Showing 10 changed files with 635 additions and 453 deletions.
9 changes: 1 addition & 8 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,21 +42,14 @@ just_the_docs:
automation:
name: Automation + extensibility
resources:
name: Resources
name: Help + support
nav_fold: true # collapse by default

# Enable relative links for collections -- https://github.com/benbalter/jekyll-relative-links
relative_links:
enabled: true
collections: true

# Links under the left nav
nav_external_links:
- title: ❤️ Give feedback
url: https://aka.ms/ftk/feedback
hide_icon: false
opens_in_new_tab: true

# Footer
# footer_content: ''
gh_edit_link: true
Expand Down
7 changes: 7 additions & 0 deletions docs/_includes/components/site_nav.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@
| where_exp:"item", "item.parent == nil"
| where_exp:"item", "item.nav_exclude != true"
| size %}

<ul class="nav-list">
<li class="nav-list-item"><a href="/finops-toolkit" class="nav-list-link">🧰 Home</a></li>
<li class="nav-list-item"><a href="/finops-toolkit/help" class="nav-list-link">❔ Get help</a></li>
<li class="nav-list-item"><a href="https://aka.ms/ftk/feedback" target="_blank" class="nav-list-link">❤️ Give feedback</a></li>
</ul>

{% if pages_top_size > 0 %}
{% include components/nav.html pages=site.html_pages %}
{% endif %}
Expand Down
35 changes: 35 additions & 0 deletions docs/_resources/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
layout: default
title: Help + support
nav_order: 0
nav_exclude: true
description: 'Details and solutions for common issues you may experience.'
permalink: /help
---

<span class="fs-9 d-block mb-4">Help + support</span>
Sorry to hear you're having a problem. We're here to help!
{: .fs-6 .fw-300 }

[Troubleshoot issues](./troubleshooting.md){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-4 }
[Ask a question](https://aka.ms/ftk/discuss){: .btn .fs-5 .mb-4 .mb-md-0 .mr-4 }

---

Have questions about implementing FinOps within your org? Start with [FinOps discussions](https://aka.ms/finops/discuss).

Have a question about deploying or using tools in the FinOps toolkit?

- [Deployment options](./deploy.md)
- [Data dictionary](./data-dictionary.md)
- [Common terms](./terms.md)

Need help with an issue you're facing with one of the tools in the FinOps toolkit?

- [Support overview](./support.md)
- [Common errors](./errors.md)
- [Troubleshooting guide](./troubleshooting.md)

To learn more about recent changes, check out the [Changelog](./changelog.md).

<br>
2 changes: 2 additions & 0 deletions docs/_resources/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ Legend:
> 1. Ingest FOCUS 1.0 data in FinOps hubs.
> 2. Grant access to FinOps hubs to [create and manage exports](../_reporting/hubs/configure-scopes.md#-configure-managed-exports) for you.
> 3. Connect to a hub instance in another Entra ID tenant.
> 4. Step-by-step troubleshooting guide and expanded set of common errors for validating FinOps hubs and Power BI setup.
>
> 🛠️ Fixed:
>
Expand All @@ -101,6 +102,7 @@ Legend:
>
> - General:
> 1. **x_IncrementalRefreshDate** column to facilitate configuring incremental refresh in Power BI.
> 2. Step-by-step troubleshooting guide and expanded set of common errors for validating Power BI setup.
> - [Cost summary](../_reporting/power-bi/cost-summary.md):
> 1. Resource count and cost per resource in the [Inventory page](../_reporting/power-bi/cost-summary.md#inventory).
> - [Data ingestion](../_reporting/power-bi/data-ingestion.md):
Expand Down
252 changes: 126 additions & 126 deletions docs/_resources/data-dictionary.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/_resources/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: default
title: Deployment options
nav_order: 10
description: 'Deploy FinOps toolkit solutions.'
permalink: /resources/deploy
permalink: /help/deploy
---

<span class="fs-9 d-block mb-4">FinOps toolkit deployment options</span>
Expand Down
353 changes: 353 additions & 0 deletions docs/_resources/errors.md

Large diffs are not rendered by default.

39 changes: 39 additions & 0 deletions docs/_resources/support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
layout: default
title: Get support
nav_order: 777
description: 'How to get the help you need.'
permalink: /help/support
---

<span class="fs-9 d-block mb-4">Help + support</span>
Sorry to hear you're having a problem. We're here to help!
{: .fs-6 .fw-300 }

[Troubleshoot issues](./troubleshooting.md){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-4 }
[Ask a question](https://aka.ms/ftk/discuss){: .btn .fs-5 .mb-4 .mb-md-0 .mr-4 }

---

Tools and resources within the FinOps toolkit are provided as-is without any express or implied warranties. Microsoft Support does not handle support requests for the FinOps toolkit, however the underlying products leveraged by tools in the toolkit are officially supported.

> [!NOTE]
> The term "tool" is being used to indicate a software offering. "Products" are tools that are operationally managed by Microsoft. "Solutions" are pre-configured tools that may use a mix of managed products and custom code and are deployed and managed by you (or another organization on your behalf).
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).

2. **Confirm all setup instructions were completed in order.**<br>9 out of 10 issues are due to missing steps. Please follow instructions carefully.

3. **Walk through the [troubleshooting guide](./troubleshooting.md).**<br>The most common issues and their solutions are documented and should be able to be resolved independently.

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?

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).

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.

<br>
2 changes: 1 addition & 1 deletion docs/_resources/terms.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: default
title: Common terms
nav_order: 30
description: 'Common terms and definitions used throughout FinOps hubs.'
permalink: /resources/terms
permalink: /help/terms
---

<span class="fs-9 d-block mb-4">Common terms</span>
Expand Down
Loading

0 comments on commit 0fc7770

Please sign in to comment.