Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This refactors the
docs/
directory intodocs/
anddocs-dev/
foruser documentation and developer documentation,
with the following overall motivations:
Remove developer documentation from HTML documentation so that users do not
land on it. Ideally this would be something like
docs/user/
anddocs/dev/
but GitHub does not allow using anything except
docs/
for the root.Change PKCS#11 library documentation to focus exclusively on the case of
users installing it in production. This means replacing mentions of
"the user you will run aziot-keyd as" with "aziotks", etc.
Don't link to HTTP API docs from the index since they're only useful
for host module authors. They're linked from the host-module doc instead.
Also, the TPM service is exclusively an internal service, so move it to
developer docs.
Move
packaging.md
to developer docs since the user does not needthe level of detail it provides about what the package contains.
The user docs only cover the super-config and a new page about
the
aziotctl
binary.Hard-code the nav bar instead of letting Jekyll generate it, so that
it preserves the order of pages rather than sort them alphabetically.