website/integrations: chronograf: document#12474
Conversation
Adds the version proposed in https://github.com/goauthentik/authentik/blob/8ac6761920bab879b03b2b5ce3b9da3075f95953/website/integrations/services/chronograf/index.md . Signed-off-by: 4d62 <github-user@sdko.org>
Adds a `sidebar_label`, updates the start of the documentation to the follow the template, and updates `service.company` to `chronograf.company` in the preparation documentation. Signed-off-by: 4d62 <github-user@sdko.org>
Adds the integration to the `sidebarsIntegration.js` file. Signed-off-by: 4d62 <github-user@sdko.org>
Rewrite most of the documentation, cleanup unneeded bits, and update format. Signed-off-by: 4d62 <github-user@sdko.org>
This PR is now ready for review. Cleans up sentence structure, grammar, and visual stuff. Signed-off-by: 4d62 <github-user@sdko.org>
Links modified file with prettier. Signed-off-by: 4d62 <github-user@sdko.org>
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for authentik-storybook ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Adds `USE_ID_TOKEN=true` to the list of needed environment following this comment in the initial merge request: #7766 (comment) Signed-off-by: 4d62 <github-user@sdko.org>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #12474 +/- ##
==========================================
- Coverage 92.76% 92.69% -0.08%
==========================================
Files 770 770
Lines 38859 38859
==========================================
- Hits 36048 36019 -29
- Misses 2811 2840 +29
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
|
||
| ## authentik configuration | ||
|
|
||
| 1. From the **authentik admin interface**, navigate to **Applications** -> **Applications** on the left sidebar. |
There was a problem hiding this comment.
| 1. From the **authentik admin interface**, navigate to **Applications** -> **Applications** on the left sidebar. | |
| 1. From the authentik Admin interface navigate to **Applications** -> **Applications** on the left sidebar. |
There was a problem hiding this comment.
You allowed me to keep "authentik Admin interface" in bold here. Should I keep or remove it? Also, I believe a comma is still needed. I suggest:
Where’s this button?
It’s gone because the suggestion is outdated. Anyway, I suggest: From the **authentik Admin interface**, navigate to **Applications** -> **Applications** on the left sidebar. or From the authentik Admin interface, navigate to **Applications** -> **Applications** on the left sidebar. Additionally, I recommend updating the other PR.
There was a problem hiding this comment.
Will apply suggestion as-is for now
There was a problem hiding this comment.
Sorry just saw this again, Yeah, consistency is a real bear. OK, I took a look at regular docs (not integrations) and we do not bold Admin interface. Bold is used for labels, buttons, field names, sections of the UI, enttries in the nav pane of the UI... but not when referring to the Admin interface in general. (I guess there could theoretically be a sentence whhere we tell users to click on the button called Admin interface in the UI, but...).
So yeah, let's not use bold for that.
Commas. I love commas and overuse them like crazy. They are almost a personal choice, at this point. You can keep that comma, it is friendly and causes no harm.
Also thank you very much for all of your contributions to our integration guides.
There was a problem hiding this comment.
no problem. happy to help around.
tanberry
left a comment
There was a problem hiding this comment.
Thanks so much @4d62 for helping clean up old PRs! Very appreciated. Shout out to @tomlawesome for starting this one, last year.
Just a few nitpicky nits, then let's merge!
Applies suggestions from the first review round
|
Hey @tanberry, no problem! Happy to help. I've applied your suggestions but left one review suggestion open due to a discrepancy between this PR and my Komga one. Also, would you prefer telling users to create an application and a provider using the new wizard? I can update the existing documentation if needed. I do remember hearing that you all were slowly transitioning toward wizard-based management. |
There was a problem hiding this comment.
Thanks! And yeah, I want to learn more about whether there is any valid need to first create the provider and then the app. If not, yes, for sure, we'll need to switch to telloing people to using the Wizard.
As for the discrepency with the Komga PR... I lost track... is it about the bolding/non-bolding?
|
* main: website/integrations: meshcentral: document (#12509) stages/authenticator_webauthn: Update FIDO MDS3 & Passkey aaguid blobs (#12524) core: bump goauthentik.io/api/v3 from 3.2024121.2 to 3.2024121.3 (#12522) web: bump API Client version (#12520) website/integrations: chronograf: document (#12474) website/integrations: update preparation placeholder (#12507) providers/saml: fix handle Accept: application/xml for SAML Metadata endpoint (#12483) (#12518) core: bump aws-cdk-lib from 2.173.3 to 2.173.4 (#12513) website: bump aws-cdk from 2.173.3 to 2.173.4 in /website (#12514) core: bump coverage from 7.6.9 to 7.6.10 (#12499) core: bump aws-cdk-lib from 2.173.2 to 2.173.3 (#12500) website: bump aws-cdk from 2.173.2 to 2.173.3 in /website (#12501) core: bump github.com/go-ldap/ldap/v3 from 3.4.9 to 3.4.10 (#12502) website/docs: New "Whats Up Docker" URL (#12488)
sdko/feat/integration/pickup-7766
Details
Adds documentation for https://www.influxdata.com/time-series-platform/chronograf/
Closes #7766 , a pull request which has not been updated in some time.
Checklist
ak test authentik/)make lint-fix)If an API change has been made
make gen-build)If changes to the frontend have been made
make web)If applicable
make website)