Skip to content

Commit 8dbf62a

Browse files
making review changes
1 parent 5d3fdac commit 8dbf62a

File tree

4 files changed

+9
-200
lines changed

4 files changed

+9
-200
lines changed

articles/trusted-signing/concept.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Signing concepts #Required; page title is displayed in search results. Include the brand.
2+
title: Trusted Signing concepts #Required; page title is displayed in search results. Include the brand.
33
description: Describing signing concepts and resources in Trusted Signing #Required; article description that is displayed in search results.
44
author: microsoftshawarma #Required; your GitHub user alias, with correct capitalization.
55
ms.author: rakiasegev #Required; microsoft alias of author; optional team alias.
@@ -47,26 +47,10 @@ Follow the H2 headings with a sentence about how the section contributes to the
4747
## Resource Types
4848
Trusted Signing has the following resource types:
4949

50-
*Code Signing Account – Logical container holding certificate profiles and considered the Trusted Signing resource.
51-
*Certificate Profile – Template with the information that is used in the issued certificates, and a subresource to a Code Signing Account resource.
50+
* Code Signing Account – Logical container holding certificate profiles and considered the Trusted Signing resource.
51+
* Certificate Profile – Template with the information that is used in the issued certificates, and a subresource to a Code Signing Account resource.
5252

5353

5454
In the below example structure, you notice that an Azure Subscription has a resource group and under that resource group you can have one or many Code Signing Account resources with one or many Certificate Profiles. This ability to have multiple Code Signing Accounts and Certificate Profiles is useful as the service supports Public Trust, Private Trust, VBS Enclave, and Test signing.
5555

5656
![Diagram of Azure Code Signing resource group and cert profiles.](./media/trusted-signing-resource-structure.png)
57-
58-
## [Section 2 heading]
59-
<!-- add your content here -->
60-
61-
## [Section n heading]
62-
<!-- add your content here -->
63-
64-
<!-- 4. Next steps
65-
Required. Provide at least one next step and no more than three. Include some
66-
context so the customer can determine why they would click the link.
67-
68-
<!--
69-
Remove all the comments in this template before you sign-off or merge to the
70-
main branch.
71-
72-
-->

articles/trusted-signing/faq.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ sections:
4343
*[Review permissions granted to applications](https://learn.microsoft.com/entra/identity/enterprise-apps/manage-application-permissions?pivots=portal.
4444
- question: What if I don’t see Microsoft.CodeSigning in my resource provider?
4545
answer: |
46-
Register the Microsoft.CodeSigning app in the subscription resource provider page using the below screenshot as a guide: :::image type="content" source="media/trusted-signing-resource-provider.png" alt-text="Screenshot of registering Microsoft.CodeSigning resource provider.":::
46+
Register the Microsoft.CodeSigning app in the subscription resource provider page using the below screenshot as a guide: :::image type="content" source="media/trusted-signing-resource-provider.png" alt-text="Screenshot of registering Microsoft.CodeSigning resource provider." lightbox="media/trusted-signing-resource-provider.png":::
4747
- question: What if I fail identity validation?
4848
answer: |
4949
If more documentation is required for identity validation, you're asked to provide those documents on the Azure portal. Otherwise, we recommend checking for an email sent to the listed address for email validation. However, if your organization fails identity validation we can't onboard you to Trusted Signing. We recommend you delete your Trusted Signing account so you don't get billed for unused resources.

articles/trusted-signing/how-to-signing-integrations.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ ms.custom: template-how-to-pattern #Required; leave this attribute/value as-is.
1212
# Implement Signing Integrations with Trusted Signing
1313

1414
Trusted Signing currently supports the following signing integrations:
15-
SignTool
16-
GitHub Action
17-
ADO Task
18-
PowerShell for Authenticode
19-
Azure PowerShell - App Control for Business CI Policy
15+
* SignTool
16+
* GitHub Action
17+
* ADO Task
18+
* PowerShell for Authenticode
19+
* Azure PowerShell - App Control for Business CI Policy
2020
We constantly work to support more signing integrations and will update the above list if/when more are available.
2121

2222
This article explains how to set up each of the above Trusted Signing signing integrations.

articles/trusted-signing/quickstart.md

Lines changed: 0 additions & 175 deletions
Original file line numberDiff line numberDiff line change
@@ -54,178 +54,3 @@ of applicable links for companion content at the end of the introduction. Don't
5454
if there's only a single link. In general, these links are more important for SDK-based quickstarts. -->
5555

5656
Trusted Signing overview | Reference documentation | Sample source code
57-
58-
<!-- 5. Prerequisites --------------------------------------------------------------------
59-
60-
Optional: Make Prerequisites the first H2 after the H1. Omit any preliminary text to the list.
61-
62-
Include this heading even if there aren't any prerequisites, in which case just use the text: "None"
63-
(not bulleted). The reason for this is to maintain consistency across services, which trains readers
64-
to always look in the same place.
65-
66-
When there are prerequisites, list each as *items*, not instructions to minimize the verbiage.
67-
For example, use "Python 3.6" instead of "Install Python 3.6". If the prerequisite is something
68-
to install, link to the applicable and specific installer or download. Selecting the item/link is then the
69-
action to fulfill the prerequisite. Use an action word only if necessary to make the meaning clear.
70-
Don't use links to conceptual information about a prerequisite; only use links for installers.
71-
72-
Do not bold items, because listing items alone fulfills that same purpose.
73-
74-
List prerequisites in the following order:
75-
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
76-
- Language runtimes (Python, Node, .NET, etc.)
77-
- Packages (from pip, npm, nuget, etc.)
78-
- Tools (like VS Code IF REQUIRED. Don't include tools like pip if they're
79-
automatically installed with another tool or language runtime, like Python. Don't include
80-
optional tools like text editors--include them only if the quickstart demonstrates them.)
81-
- Sample code
82-
- Specialized hardware
83-
- Other preparatory work, such as creating a VM (OK to link to another article)
84-
- Azure keys
85-
- Service-specific keys
86-
87-
The reason for placing runtimes and tools first is that it might take time to install
88-
them, and it's best to get a user started sooner than later.
89-
90-
If you feel like your quickstart has a lot of prerequisites, the quickstart may be the
91-
wrong content type - a tutorial or how-to guide may be the better option. Remember that
92-
quickstarts should be something a reader can complete in 10 minutes or less.
93-
94-
-->
95-
96-
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
97-
- Azure tenant ID
98-
- Second prerequisite
99-
- Third prerequisite
100-
- ...
101-
- (Any specific service-specific key - if specific actions are required, either link to an article that explains those steps, or make acquisition of a key one of the steps in the quickstart.)
102-
103-
<!-- 6. Account sign in --------------------------------------------------------------------
104-
105-
Required: If you need to sign in to the portal to do the quickstart, this H2 and link are required.
106-
107-
-->
108-
109-
## Sign in to <service/product/tool name>
110-
TODO: add your instructions
111-
112-
<!-- If signing in requires more than one step, then use this section. If it's just a single
113-
step, include that step in the first section that requires it.
114-
115-
-->
116-
117-
<!-- 7. Open Azure Cloud Shell---------------------------------------------------------------------
118-
If you want to refer to using the Cloud Shell, place the instructions after the
119-
Prerequisites to keep the prerequisites as the first H2.
120-
121-
However, only include the Cloud Shell if ALL commands can be run in the cloud shell.
122-
123-
--->
124-
125-
126-
## Open Azure Cloud Shell
127-
TODO: add your instructions
128-
129-
<!-- 7. Task H2s ------------------------------------------------------------------------------
130-
131-
Required:
132-
Quickstarts are prescriptive and guide the customer through an end-to-end procedure.
133-
Make sure to use specific naming for setting up accounts and configuring technology.
134-
135-
Avoid linking off to other content - include whatever the customer needs to complete the
136-
scenario in the article. For example, if the customer needs to set permissions, include the
137-
permissions they need to set, and the specific settings in the quickstart procedure. Don't
138-
send the customer to another article to read about it.
139-
140-
In a break from tradition, do not link to reference topics in the procedural part of the
141-
quickstart when using cmdlets or code. Provide customers what they need to know in the quickstart
142-
to successfully complete the quickstart.
143-
144-
For portal-based procedures, minimize bullets and numbering.
145-
146-
For the CLI or PowerShell based procedures, don't use bullets or numbering.
147-
148-
Be mindful of the number of H2/procedures in the Quickstart. 3-5 procedural steps are about right.
149-
Once you've staged the article, look at the right-hand "In this article" section on the docs page;
150-
if there are more than 8 total, consider restructuring the article.
151-
152-
--->
153-
154-
## Task 1
155-
TODO: Include a sentence or two to explain only what is needed to complete the
156-
procedure.
157-
158-
1. Step 1 of the procedure
159-
1. Step 2 of the procedure
160-
1. Step 3 of the procedure
161-
1. Step 4 of the procedure
162-
163-
## Task 2
164-
165-
TODO: Include a sentence or two to explain only what is needed to complete the procedure.
166-
167-
1. Step 1 of the procedure
168-
1. Step 2 of the procedure
169-
1. Step 3 of the procedure
170-
171-
## Task 3
172-
173-
TODO: Include a sentence or two to explain only what is needed to complete the procedure.
174-
175-
<!-- 7. Code blocks ------------------------------------------------------------------------------
176-
177-
Optional: Code requires specific formatting. Here are a few useful examples of
178-
commonly used code blocks. Make sure to use the interactive functionality where
179-
possible.
180-
For the CLI or PowerShell based procedures, don't use bullets or numbering.
181-
182-
Here is an example of a code block for Java:
183-
184-
```java
185-
cluster = Cluster.build(new File("src/remote.yaml")).create();
186-
...
187-
client = cluster.connect();
188-
```
189-
190-
or a code block for Azure CLI:
191-
192-
```azurecli
193-
az vm create --resource-group myResourceGroup --name myVM --image win2016datacenter --admin-username azureuser --admin-password myPassword12
194-
```
195-
or a code block for Azure PowerShell:
196-
197-
```azurepowershell
198-
New-AzureRmContainerGroup -ResourceGroupName myResourceGroup -Name mycontainer -Image mcr.microsoft.com/windows/servercore/iis:nanoserver -OsType Windows -IpAddressType Public
199-
```
200-
201-
<!-- Use the -interactive CLI/PowerShell code fences ONLY if all such commands can be marked that way,
202-
otherwise the reader might run some in the interactive in which case the state isn't determinate.
203-
204-
--->
205-
206-
<!-- 8. Clean up resources ------------------------------------------------------------------------
207-
208-
Required: To avoid any costs associated with following the quickstart procedure, a
209-
Clean up resources (H2) should come just before Next steps (H2)
210-
211-
If there is a follow-on quickstart that uses the same resources, make that option clear
212-
so that a reader doesn't need to recreate those resources.
213-
214-
-->
215-
216-
## Clean up resources
217-
218-
If you're not going to continue to use this application, delete resources with the following steps
219-
220-
221-
<!-- 9. Next steps ------------------------------------------------------------------------
222-
223-
Required: Quickstarts should always have a Next steps H2 that points to the next logical
224-
quickstart in a series, or, if there are no other quickstarts, to some other
225-
cool thing the customer can do. A single link in the blue box format should
226-
direct the customer to the next article - and you can shorten the title in the
227-
boxes if the original one doesn’t fit.
228-
229-
Do not use a "More info section" or a "Resources section" or a "See also section".
230-
231-
--->

0 commit comments

Comments
 (0)