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

doc updates #1750

Draft
wants to merge 50 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
bf7cd12
initial brainstorm
matebarabas Oct 30, 2024
e20ed96
adding quickstart draft
matebarabas Oct 30, 2024
97ef4fd
first draft
ReneHezser Oct 31, 2024
7e28e6f
wip
ReneHezser Nov 6, 2024
fae8c51
feat: [feat/doc-updates] open external links in new tab/window (#1652)
ReneHezser Nov 6, 2024
8f1063f
moves image
ReneHezser Nov 6, 2024
3ff25c5
sync with feat/doc-updates
ReneHezser Nov 6, 2024
3cc0efa
[feat/doc-updates] main-sync (#1708)
matebarabas Nov 7, 2024
11d9974
Merge remote-tracking branch 'upstream/feat/doc-updates' into quickst…
ReneHezser Nov 8, 2024
6861a88
Merge branch 'Azure:main' into quickstart-bicep
ReneHezser Nov 14, 2024
5323cc5
wip
ReneHezser Nov 22, 2024
30b0b06
enabling quick start guide in the menu
matebarabas Dec 5, 2024
e55e1c6
update quickstart main page
matebarabas Dec 5, 2024
30d2016
moving content from faq and adding initial steps
matebarabas Dec 5, 2024
c151694
Merge branch 'feat/doc-updates-2' of https://github.com/Azure/Azure-V…
ReneHezser Dec 6, 2024
8da06a7
updates
ReneHezser Dec 6, 2024
61f00a8
[doc-updates] Quickstart bicep (#1753)
ReneHezser Dec 9, 2024
77409e4
image path updates
matebarabas Dec 9, 2024
bb0a54d
periodic save
jchancellor-ms Dec 10, 2024
cbff908
mp4 cleanup
jchancellor-ms Dec 10, 2024
9062a9a
renaming image folder
matebarabas Dec 10, 2024
86eddc7
initial draft
jchancellor-ms Dec 10, 2024
b9bb22a
fix
jchancellor-ms Dec 10, 2024
b3fa149
bicep wip
matebarabas Dec 10, 2024
679eba5
Merge branch 'feat/doc-updates-2' of https://github.com/Azure/Azure-V…
matebarabas Dec 10, 2024
155e574
tf updates
matebarabas Dec 10, 2024
933f239
image link fix
jchancellor-ms Dec 11, 2024
7963bf3
mp4 changes
jchancellor-ms Dec 11, 2024
00cbfb4
review draft
jchancellor-ms Dec 11, 2024
9cd78d0
video update
matebarabas Dec 11, 2024
4ece283
Merge branch 'feat/doc-updates-2' of https://github.com/Azure/Azure-V…
matebarabas Dec 11, 2024
a2a2832
terraform updates
matebarabas Dec 11, 2024
28d78c5
terraform updates
matebarabas Dec 11, 2024
dd57f5a
bicep updates
matebarabas Dec 11, 2024
02f25c4
bicep updates
matebarabas Dec 11, 2024
f6e909e
added Clarity JS
ReneHezser Dec 11, 2024
2388517
bicep quickstart updates
ReneHezser Dec 11, 2024
0b31225
tf option 1 videos
jchancellor-ms Dec 11, 2024
763090b
Merge branch 'feat/doc-updates-2' of github.com:Azure/Azure-Verified-…
jchancellor-ms Dec 11, 2024
6c1e21e
updates
ReneHezser Dec 11, 2024
598ec11
bicep updates
matebarabas Dec 12, 2024
7b1dc73
bicep spell-check
matebarabas Dec 12, 2024
0bc6d5a
changed key to secret
ReneHezser Dec 12, 2024
328f2a5
tf module details
jchancellor-ms Dec 12, 2024
322d98a
command video
jchancellor-ms Dec 12, 2024
8abb5a4
Grammar and notes
jchancellor-ms Dec 13, 2024
b414b92
tf - minor spelling and indentation updates
matebarabas Dec 13, 2024
8d0c9c4
bicep - minor language updates
matebarabas Dec 13, 2024
6207995
tf - spelling fix
matebarabas Dec 13, 2024
c98a25e
TF minor updates
matebarabas Dec 13, 2024
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
4 changes: 0 additions & 4 deletions docs/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@ enableRobotsTXT = true
tag = "tags"

[params]

# Include custom JS files
customJS = ["js/clarity.js"]

# (Optional, default 6) Set how many table of contents levels to be showed on page.
# Use false to hide ToC, note that 0 will default to 6 (https://gohugo.io/functions/default/)
# You can also specify this parameter per page in front matter.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/contributing/website/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ When in VS Code you should be able to open a terminal and run the below commands

```text
cd docs
hugo server -D
hugo server -D // you can add "--poll 700ms", if file changes are not detected
```

### Software/Applications
Expand Down
24 changes: 1 addition & 23 deletions docs/content/faq/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -401,29 +401,7 @@ The high level steps are:

### How can I use Bicep modules through the Public Registry?

Use the [Bicep Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-bicep) to author your Bicep template and explore modules published in the Bicep Public Registry. For more details, see the the below example steps.

{{< hint type=note >}}
The Bicep VSCode extension is reading metadata through [this JSON file](https://live-data.bicep.azure.com/module-index). All modules are added to this file, as part of the publication process.
{{< /hint >}}

1. When authoring a new Bicep file, use the [VS Code extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-bicep) to explore the modules published in the Bicep Public Registry.
<img src="../img/faq/use-bicep-module-01.png" width=100% alt="Select br/public:">

2. Expanding on this you can see the AVM modules that are published.
<img src="../img/faq/use-bicep-module-02.png" width=100% alt="Select module from the Public Bicep Registry">

3. Selecting the module expands on the current available versions.
<img src="../img/faq/use-bicep-module-03.png" width=100% alt="Choose from the available versions">

4. Setting required properties exposes what is required on the module.
<img src="../img/faq/use-bicep-module-04.png" width=100% alt="Select required-properties">

5. Hovering over the `myTestModule` name exposes the module's documentation URL.
<img src="../img/faq/use-bicep-module-05.png" width=100% alt="Hover over the module name">

6. Clicking on the link opens up the Bicep Registry Repo for the AVM module's source code, where you can find the documentation detailing all the module's functionality, input parameters and outputs, while providing various examples.
<img src="../img/faq/use-bicep-module-06.png" width=100% alt="See the module's documentation online">
Please see the Bicep Quickstart guide [here](/Azure-Verified-Modules/usage/quickstart/bicep/).

---

Expand Down
27 changes: 13 additions & 14 deletions docs/content/usage/quickstart/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,16 @@ geekdocAnchor: true
geekdocCollapseSection: true
---

- this section describes the simplest way to get started with the project
- a few sentences about why I should use AVM (and/or the kv module in this example)
- am I "safe" to use the default values?
- where can I find some examples? how can I find out all the features the kv module has to offer?
- deploying a key vault the simplest way possible
- prerequisites (VS code, packages, PS modules, etc.)
- use story telling / screenshots from [FAQ](/Azure-Verified-Modules/faq/#how-can-i-use-bicep-modules-through-the-public-registry)
- how do I explore what modules are there?
- what are the built-in features of the key-vault module
- UDTs
- intellisense
- explore the source of the kv module without leaving VS code
- how can I see the readme of the kv module from vs code
- what if there's a missing feature? --> file a module issue
This quickstart section describes the simplest way to get started with the project by providing step-by-step instructions and essential information, allowing you to leverage the benefits of AVM with minimal effort. It guides you through the initial setup, including the necessary tools and configurations, to help you quickly deploy and manage your Azure resources and solutions using Azure Verified Modules (AVM).

## Why should I use Azure Verified Modules?

Using AVM ensures that your infrastructure-as-code deployments adhere to Microsoft's best practices and guidelines, providing a consistent and reliable foundation for your cloud solutions. By leveraging AVM, you can accelerate your development process, reduce the risk of misconfigurations, and enhance the security and compliance of your applications. The AVM Key Vault resource module, used as an example through this chapter, simplifies the deployment and management of Azure Key Vaults, ensuring secure storage and access to your secrets, keys, and certificates.

## Am I "safe" to use the default values?

Using the default values provided by AVM is generally safe as they are configured to follow best practices and ensure a secure and reliable setup. However, it is important to review these values to ensure they meet your specific requirements and compliance needs. Customizing the default values may be necessary to align with your organization's policies and the specific needs of your project.

## Where can I find some examples? How can I find out all the features a given module has to offer?

You can find examples and detailed documentation for the each AVM module in their respective code repository's `README.MD` file that details all the features, input parameters, and outputs. The module's documentation also provides comprehensive usage examples, covering various scenarios and configurations. Additionally, you can explore the module's source code repository. This information will help you understand the full capabilities of the module and how to effectively integrate it into your projects.
Loading
Loading