Skip to content

Commit 6e80b6e

Browse files
paulsavoiepaulsavoie
authored
Merge pull request #1 from SignPath/docs-only
Docs only
2 parents d941cf5 + aa4783f commit 6e80b6e

File tree

148 files changed

+238
-4323
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

148 files changed

+238
-4323
lines changed

‎docs/_data/changelog.yml

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@
9090
application:
9191
version: 1.184.0
9292
new_features:
93-
- text: Certificate chains are now automatically resolved. See the [documentation](/documentation/managing-certificates#uploading-certificates).
93+
- text: Certificate chains are now automatically resolved. See the [documentation](/managing-certificates#uploading-certificates).
9494
issues: [SIGN-7551]
9595
improvements:
9696
- text: Uploaded X.509 certificate chains are now embedded in the signature when using the `<authenticode-sign>` directive.
@@ -110,7 +110,7 @@
110110
- text: |-
111111
Added support for storing and retrieving X.509 certificate chains (for e.g. certificates issued by in-house PKIs).
112112
issues: [SIGN-7423]
113-
- text: Added support for `file-version`, `company-name`, `copyright`, and `original-filename` to [`<pe-file>` metadata restrictions](/documentation/artifact-configuration/reference#metadata-restrictions).
113+
- text: Added support for `file-version`, `company-name`, `copyright`, and `original-filename` to [`<pe-file>` metadata restrictions](/artifact-configuration/reference#metadata-restrictions).
114114
issues: [SIGN-7395]
115115
improvements:
116116
- text: |-
@@ -146,7 +146,7 @@
146146
github_connector:
147147
version: 1.2.0
148148
improvements:
149-
- text: The [SignPath GitHub App](/documentation/trusted-build-systems/github) is only required if source code and build policy verification is used.
149+
- text: The [SignPath GitHub App](/trusted-build-systems/github) is only required if source code and build policy verification is used.
150150
issues: [SIGN-7506]
151151
bug_fixes:
152152
- text: Fixed bug for workflow runs with skipped jobs.
@@ -177,7 +177,7 @@
177177
* moved Organization ID and API token parameters to the "inner" scenario scripts
178178
* improved Cryptoki library discovery
179179
* various minor improvements
180-
* [GPG-based hash signing](/documentation/crypto-providers/gpg): GPG public key file is now downloaded automatically. Therefore the `-GpgKeyId` parameter of the scenario scripts has been replaced with `-ProjectSlug` and `-SigningPolicySlug`.
180+
* [GPG-based hash signing](/crypto-providers/gpg): GPG public key file is now downloaded automatically. Therefore the `-GpgKeyId` parameter of the scenario scripts has been replaced with `-ProjectSlug` and `-SigningPolicySlug`.
181181
* Changed work directory from `Samples/Scenarios/temp` to `Samples/Scenarios/Work` and logs directory to `Samples/Scenarios/Work/Logs`.
182182
* Added detached CMS signing sample to the OpenSSL scenario.
183183
issues: [SIGN-7410, SIGN-7497]
@@ -198,17 +198,17 @@
198198
version: 1.179.0
199199
new_features:
200200
- text: |-
201-
Added support for [detached GPG file signing](/documentation/artifact-configuration/reference#create-gpg-signature).
201+
Added support for [detached GPG file signing](/artifact-configuration/reference#create-gpg-signature).
202202
issues: [SIGN-7455]
203203
- text: |-
204204
The signing request details page now displays details of detected malware including threat names and the exact file location in container files like ZIP archives.
205205
issues: [SIGN-7454]
206206
improvements:
207207
- text: |-
208-
[`<create-raw-signature>`](/documentation/artifact-configuration/reference#create-raw-signature): renamed `file-name` attribute to `output-file-name`. (`file-name` is still supported for backwards compatibility.)
208+
[`<create-raw-signature>`](/artifact-configuration/reference#create-raw-signature): renamed `file-name` attribute to `output-file-name`. (`file-name` is still supported for backwards compatibility.)
209209
issues: [SIGN-7490]
210210
- text: |-
211-
[`<create-cms-signature>`](/documentation/artifact-configuration/reference#create-cms-signature): `hash-algorithm` attribute is now optional.
211+
[`<create-cms-signature>`](/artifact-configuration/reference#create-cms-signature): `hash-algorithm` attribute is now optional.
212212
issues: [SIGN-7507]
213213
bug_fixes:
214214
- text: |-
@@ -228,14 +228,14 @@
228228
application:
229229
version: 1.177.2
230230
new_features:
231-
- text: Added support for [Cryptographic Message Syntax (CMS) signatures](/documentation/artifact-configuration/reference#create-cms-signature).
231+
- text: Added support for [Cryptographic Message Syntax (CMS) signatures](/artifact-configuration/reference#create-cms-signature).
232232
issues: [SIGN-7477]
233233
- date: '2024-12-16'
234234
updates:
235235
github_connector:
236236
version: 1.1.0
237237
new_features:
238-
- text: Policy checks for branch rulesets, build and build runner are supported. See the [documentation](/documentation/trusted-build-systems/github#build-and-source-code-policies).
238+
- text: Policy checks for branch rulesets, build and build runner are supported. See the [documentation](/trusted-build-systems/github#build-and-source-code-policies).
239239
issues: [SIGN-7266, SIGN-7285, SIGN-2792, SIGN-7424, SIGN-7433, SIGN-7266, SIGN-7199, SIGN-7198]
240240
bug_fixes:
241241
- text: Fixed a bug that prevented signing requests from being submitted when the "re-run failed jobs" feature of workflows was used for workflows with multiple jobs.
@@ -248,7 +248,7 @@
248248
version: 1.177.0
249249
new_features:
250250
- text: |-
251-
Added [GPG key management](/documentation/managing-certificates):
251+
Added [GPG key management](/managing-certificates):
252252
* GPG keys can now be created directly in the SignPath UI.
253253
* They can currently be used for hash signing and `create-raw-signature`.
254254
issues: [SIGN-7247]
@@ -294,10 +294,10 @@
294294
version: 5.1.0
295295
new_features:
296296
- text: |-
297-
Added support for using GPG keys generated by [SignPath certificate management](/documentation/managing-certificates):
297+
Added support for using GPG keys generated by [SignPath certificate management](/managing-certificates):
298298
* It is no longer required to locally generate GPG keys based on backing X.509 certificates. You can create GPG keys directly in the SignPath UI.
299299
* Requires SignPath version 1.177 or higher.
300-
* Adapted and simplified the Linux container samples for [GPG hash signing](/documentation/crypto-providers/gpg).
300+
* Adapted and simplified the Linux container samples for [GPG hash signing](/crypto-providers/gpg).
301301
issues: [SIGN-7341, SIGN-7318]
302302
improvements:
303303
- text: |-
@@ -361,7 +361,7 @@
361361
jenkins_plugin:
362362
version: '2.1.0'
363363
new_features:
364-
- text: Added support for [user-defined parameters](/documentation/artifact-configuration/syntax#parameters).
364+
- text: Added support for [user-defined parameters](/artifact-configuration/syntax#parameters).
365365
issues: [SIGN-6986]
366366
improvements:
367367
- text: The _API Token Credential_ can now be stored either in th _System_ or a _Global_ (recommended) scope.
@@ -416,7 +416,7 @@
416416
issues: [SIGN-7248]
417417
new_features:
418418
- text: |-
419-
ECDSA hash signing: added support for signature block format "RFC 3279 ASN.1 sequence". See [artifact format for signing hash digests](/documentation/crypto-providers/rest-api#hash-signing-payload-json).
419+
ECDSA hash signing: added support for signature block format "RFC 3279 ASN.1 sequence". See [artifact format for signing hash digests](/crypto-providers/rest-api#hash-signing-payload-json).
420420
issues: [SIGN-7240]
421421
improvements:
422422
- text: |-
@@ -485,7 +485,7 @@
485485
github_connector:
486486
version: '1.0' # note is 0.8 in connectors release
487487
new_features:
488-
- text: 'Initial release: GitHub.com is now available as a [Trusted Build System](/documentation/trusted-build-systems).'
488+
- text: 'Initial release: GitHub.com is now available as a [Trusted Build System](/trusted-build-systems).'
489489
- date: '2024-08-13'
490490
updates:
491491
application:
@@ -532,7 +532,7 @@
532532
For all other `v1` APIs, `multipart/form-data` is no longer available.
533533
issues: [SIGN-7050]
534534
- text: |-
535-
Authenticode signing now supports the following [optional attributes](/documentation/artifact-configuration/reference#authenticode-sign-attributes):
535+
Authenticode signing now supports the following [optional attributes](/artifact-configuration/reference#authenticode-sign-attributes):
536536
* `description` and `description-url`
537537
* `hash-algorithm`
538538
issues: [SIGN-5410, SIGN-7177]
@@ -594,7 +594,7 @@
594594
version: 1.168.1
595595
new_features:
596596
- text: >-
597-
Added support for [appending Authenticode signatures](/documentation/artifact-configuration/reference#authenticode-sign-attributes).
597+
Added support for [appending Authenticode signatures](/artifact-configuration/reference#authenticode-sign-attributes).
598598
issues: [SIGN-7004]
599599
improvements:
600600
- text: >-
@@ -660,13 +660,13 @@
660660
* Use `SIGNPATH_LOG_CONSOLE_LEVEL=none` to opt-out from file logging.
661661
* Console logging (if enabled) now logs to stderr instead of stdout by default.
662662
* Use the new `SIGNPATH_LOG_CONSOLE_OUTPUT_STREAM` configuration to switch back to `stdout`.
663-
* See [Crypto Provider configuration](/documentation/crypto-providers#crypto-provider-configuration) for details.
663+
* See [Crypto Provider configuration](/crypto-providers#crypto-provider-configuration) for details.
664664
issues: [SIGN-6987]
665665
new_features:
666666
- text: |-
667667
The Windows Crypto Providers (incl. KSP, CSP and Cryptoki library) now are delivered with a Windows MSI installer.
668668
669-
* See [install/uninstall docs](/documentation/crypto-providers/windows#installation). This also includes unattended installation options.
669+
* See [install/uninstall docs](/crypto-providers/windows#installation). This also includes unattended installation options.
670670
* To upgrade from a previous _manual_ installation/registration or from an `InstallCspKsp.ps1` installation:
671671
* Install using the new MSI
672672
* In case you used a `SIGNPATH_CONFIG_FILE` JSON file: copy its content to `%ProgramFiles%\SignPath\CryptoProviders\CryptoProvidersConfig.json`
@@ -739,7 +739,7 @@
739739
version: 1.163.0
740740
new_features:
741741
- text: >-
742-
Authenticode files can now be signature _validated_ with the new [`<authenticode-verify />`](/documentation/artifact-configuration/reference#authenticode-verify) artifact configuration directive.
742+
Authenticode files can now be signature _validated_ with the new [`<authenticode-verify />`](/artifact-configuration/reference#authenticode-verify) artifact configuration directive.
743743
744744
Use to ensure that third-party components are properly signed in deep signing configurations.
745745
issues: [SIGN-2021]
@@ -802,7 +802,7 @@
802802
version: 1.160.1
803803
improvements:
804804
- text: |-
805-
Artifact configuration: [`<create-raw-signature>`](/documentation/artifact-configuration/reference#create-raw-signature) supports input filename substitution via `${file.name}`.
805+
Artifact configuration: [`<create-raw-signature>`](/artifact-configuration/reference#create-raw-signature) supports input filename substitution via `${file.name}`.
806806
issues: [SIGN-6771]
807807
- text: |-
808808
"Resubmit with current settings" now also works for signing requests which fail due to an _artifact retrieval_ error.
@@ -1193,12 +1193,12 @@
11931193
version: 1.149.2
11941194
new_features:
11951195
- text: >-
1196-
Added limited administrator roles: _User Administrator_, _Project Administrator_ and _Certificate Administrator. For more details, see the [user roles documentation](/documentation/users#roles).
1196+
Added limited administrator roles: _User Administrator_, _Project Administrator_ and _Certificate Administrator. For more details, see the [user roles documentation](/users#roles).
11971197
issues: [SIGN-6305]
11981198
- text: >-
1199-
[Select multiple files](/documentation/artifact-configuration/syntax#zip-file-element) is now generally available.
1199+
[Select multiple files](/artifact-configuration/syntax#zip-file-element) is now generally available.
12001200
issues: []
1201-
- text: Added support for deep signing of APPX and MSIX files. Read more about [deep signing](https://about.signpath.io/documentation/artifact-configuration#deep-signing-of-nested-files).
1201+
- text: Added support for deep signing of APPX and MSIX files. Read more about [deep signing](https://about.signpath.io/artifact-configuration#deep-signing-of-nested-files).
12021202
issues: [SIGN-6150]
12031203
bug_fixes:
12041204
- text: Fixes incorrect display of malware scanning status for old signing requests.
@@ -1234,7 +1234,7 @@
12341234
application:
12351235
version: 1.148.2
12361236
new_features:
1237-
- text: Added support for personal API tokens for interactive users. See [authentication](/documentation/build-system-integration#authentication).
1237+
- text: Added support for personal API tokens for interactive users. See [authentication](/build-system-integration#authentication).
12381238
issues: [SIGN-6246]
12391239
improvements:
12401240
- text: >-
@@ -1245,7 +1245,7 @@
12451245
(Existing spelling is still valid for the current schema version.)
12461246
issues: [SIGN-6000]
12471247
- text: >-
1248-
The zip archive created when uploading multiple files for signing is now named `bundle.zip`. See [`ui-multifile-upload`](/documentation/artifact-configuration/syntax#zip-file-element).
1248+
The zip archive created when uploading multiple files for signing is now named `bundle.zip`. See [`ui-multifile-upload`](/artifact-configuration/syntax#zip-file-element).
12491249
issues: [SIGN-6271]
12501250
- text: Renamed "Initial Login Email Address" of interactive users to "Account email address" in the user interface and `InteractiveUser` pre-release APIs.
12511251
issues: [SIGN-6069]
@@ -1313,7 +1313,7 @@
13131313
application:
13141314
version: 1.146.0
13151315
new_features:
1316-
- text: Added [`ui-multifile-upload`](/documentation/artifact-configuration/syntax#zip-file-element) feature to upload multiple files in signing request web client UI (preview).
1316+
- text: Added [`ui-multifile-upload`](/artifact-configuration/syntax#zip-file-element) feature to upload multiple files in signing request web client UI (preview).
13171317
issues: [SIGN-5936]
13181318
- text: Added "Multiple Office files with macros" default artifact configuration which allows to upload multiple Office files in the user interface.
13191319
issues: [SIGN-5936]

‎docs/_data/menus/documentation.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
- text: Getting Started
2-
path: getting-started
3-
41
- text: Managing Certificates
52
path: managing-certificates
63

‎docs/_data/tables/artifact-configuration.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ similar-directories-example:
209209
</msi-file>
210210
</artifact-configuration>
211211
~~~
212-
image: "![graphical artifact configuration](/assets/img/resources/documentation/artifact-configuration/artifact-configuration_similar-definition.png)"
212+
image: "![graphical artifact configuration](/assets/img/resources/artifact-configuration/artifact-configuration_similar-definition.png)"
213213
214214
similar-directories-example-match:
215215
headers:
@@ -232,4 +232,4 @@ similar-directories-example-match:
232232
~~~
233233
234234
(All `msi`, `exe` and `dll` files are signed with Authenticode.)
235-
image: "![graphical resolved artifacts](/assets/img/resources/documentation/artifact-configuration/artifact-configuration_similar-resolved.png)"
235+
image: "![graphical resolved artifacts](/assets/img/resources/artifact-configuration/artifact-configuration_similar-resolved.png)"

‎docs/_includes/changelog_feed.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
---------------- find the last update for the passed in category (or take the latest entry)
33
{%- endcomment -%}
44
{%- if include.category -%}
5-
{%- assign id = 'https://about.signpath.io/documentation/changelog/feeds/' | append: include.category | append: '.xml' -%}
5+
{%- assign id = 'https://about.signpath.io/changelog/feeds/' | append: include.category | append: '.xml' -%}
66
{%- for entry in site.data.changelog -%}
77
{%- if entry.updates -%}
88
{%- for update in entry.updates -%}
@@ -16,7 +16,7 @@
1616
{%- endif -%}
1717
{%- endfor -%}
1818
{%- else -%}
19-
{%- assign id = 'https://about.signpath.io/documentation/changelog/feeds/all.xml' -%}
19+
{%- assign id = 'https://about.signpath.io/changelog/feeds/all.xml' -%}
2020
{%- assign updated = site.data.changelog[0].date -%}
2121
{%- endif -%}
2222
<feed xmlns="http://www.w3.org/2005/Atom">
@@ -51,7 +51,7 @@
5151
<title>SignPath {{ site.data.changelog_components.details[component].label }} {{ release.version }}</title>
5252
<updated>{{ entry.date | date: '%F' }}</updated>
5353
<published>{{ entry.date | date: '%F' }}</published>
54-
<link rel="alternate" href="https://about.signpath.io/documentation/changelog#{{ entry.date | date: '%F' }}" />
54+
<link rel="alternate" href="https://about.signpath.io/changelog#{{ entry.date | date: '%F' }}" />
5555
<category term="release/{{ component }}" label="{{ site.data.changelog_components.details[component].label }}" />
5656
<summary type="html">New Release: {{ category_label }} {{ release.version }}</summary>
5757
<content type="html">

‎docs/_includes/footer.html

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
<!-- last_modified_at: -->
2-
{%- include newsletter.html -%}
32
</main>
43
<footer>
54
<div>
@@ -18,8 +17,8 @@
1817
</div>
1918
</div>
2019
<div>
21-
<a href='/privacy-policy'>Privacy Policy</a>
22-
<a href='/terms-of-service'>Terms of Service</a>
20+
<a href='https://about.signpath.io/privacy-policy'>Privacy Policy</a>
21+
<a href='https://about.signpath.io/terms-of-service'>Terms of Service</a>
2322
<a href='/status'>
2423
{%- if site.data.status.current.type == "good" -%}
2524
<span style="color: lightgreen;">
@@ -46,7 +45,7 @@ <h3>Cookie settings</h3>
4645
<p class="mobile show-more active"><a>Show more information</a></p>
4746
<p class="mobile show-less"><a>Show less information</a></p>
4847
<span class="information">By clicking the “Accept” button below, you agree that non-essential cookies on our website may be used by us and by third parties, some of them located in the USA. Learn more about our cookies in our <a
49-
href='/privacy-policy'>Privacy
48+
href='https://about.signpath.io/privacy-policy'>Privacy
5049
Policy</a>
5150
</span>
5251
<div class="actions">

0 commit comments

Comments
 (0)