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

Sample updates, trying new formatting and content flow #654

Closed

Conversation

SteveLasker
Copy link
Contributor

@SteveLasker SteveLasker commented Sep 21, 2023

A work in progress for trying a different, more detailed flow

Includes a few typos

 Mention [stepsize] in a comment if you'd like to report some technical debt. See examples here.

dependabot bot and others added 2 commits September 19, 2023 13:46
Bumps [postcss](https://github.com/postcss/postcss) from 8.4.29 to 8.4.30.
- [Release notes](https://github.com/postcss/postcss/releases)
- [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
- [Commits](postcss/postcss@8.4.29...8.4.30)

---
updated-dependencies:
- dependency-name: postcss
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: steve lasker <stevenlasker@hotmail.com>
@@ -202,10 +197,39 @@ The header and payload of the `TOKEN` may be examined with the following command

```shell
# Header
echo -n $TOKEN | cut -d '.' -f 1 | base64 -D
echo -n $TOKEN | cut -d '.' -f 1 | base64 -d | jq
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • -D seemed a typo for -d
  • Added | jq to format the output a little cleaner. Although, it does assume the developer has jq on their machine. Not sure if we want to have a doc for common tools that are assumed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't have a doc for common tools but jq is mentioned earlier in this article.

# Payload
echo -n $TOKEN | cut -d '.' -f 2 | base64 -D
echo -n $TOKEN | cut -d '.' -f 2 | base64 -d | jq
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Split the header and payload out to separate copy/paste commands. Although, with the jq output, it might be ok to merge back to one block copy/paste

@@ -32,35 +32,23 @@ When enabling non-interactive access to RKVST, you ***must*** create your first

### Using the RKVST UI to create an App Registration (First-Time Setup)

1. As an Administrator, open the `Settings` interface.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This block is mostly indentation formatting to tighten up the whitespace and make the imagery indented under the numbered lists.

{{< img src="RecordClientIDandSecret.png" alt="Rectangle" caption="<em>Record your Client ID and Secret</em>" class="border-0" >}}

5. Now that you have created your App Registration, follow the steps below to [test generating a token](./#getting-a-token-with-your-app-registration) and [ensure you can access the RKVST API](./#testing-your-access).
1. As an Administrator, open the [RKVST Portal](https://app.rkvst.io/)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Called out the URL so users can click directly. I haven't figured out how to get HUGO to open a link in a new tab, similar to just the docs does with a {:target="_blank"} addition

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this, but we should still be able to tell the story if we don't have screenshots. They are an overhead in the docs and we are aiming to reduce the use of them, where we can.

kjc-datatrails and others added 7 commits September 21, 2023 08:38
…postcss-8.4.30

Bump postcss from 8.4.29 to 8.4.30
Signed-off-by: steve lasker <stevenlasker@hotmail.com>
Signed-off-by: steve lasker <stevenlasker@hotmail.com>
Signed-off-by: steve lasker <stevenlasker@hotmail.com>
Signed-off-by: steve lasker <stevenlasker@hotmail.com>
Signed-off-by: steve lasker <stevenlasker@hotmail.com>
Signed-off-by: steve lasker <stevenlasker@hotmail.com>
@SteveLasker SteveLasker marked this pull request as ready for review September 22, 2023 05:13
@SteveLasker
Copy link
Contributor Author

I've done a first pass of validation. The multiple steps could be converted to a script, creating the rkvst-bearer.txt file. And, if we like this, we can update the other docs that need a bearer token to reference the same file. We may want to store the rkvst-bearer.txt in some local temp directory, if we can agree where that would be across Mac, Linux and WSL
cc @beekman33

@SteveLasker SteveLasker added the documentation Improvements or additions to documentation label Sep 22, 2023
Copy link
Contributor

@pcnorth pcnorth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like where this is going. Is it possible for me to pull down a local copy of this that so that I can see how it would look for a customer?

Signed-off-by: steve lasker <stevenlasker@hotmail.com>
@SteveLasker
Copy link
Contributor Author

Moved to using #669

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants