Matt Moyer
ca82609d1a
Create a site parameter and shortcode for "latestversion".
...
This gives us a single line of YAML to edit when we want to bump our docs to the latest version number.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-07-29 08:45:18 -05:00
Margo Crawford
a6dc5b912f
Document how to configure the ActiveDirectoryIdentityProvider
2021-07-28 14:35:29 -07:00
Ryan Richard
f4829178b3
Use sentence case for headers in docs
...
Following some common developer style guides such as
Google
https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings
and Microsoft
https://docs.microsoft.com/en-us/style-guide/scannable-content/headings#formatting-headings
2021-07-26 17:18:44 -07:00
Ryan Richard
e30cf6e51a
Merge branch 'main' into cli_username_password_env_vars
2021-07-22 09:29:03 -07:00
Ryan Richard
64aba7e703
Add new howto guide login.md
2021-07-21 12:10:47 -07:00
Margo Crawford
a7af63ca3a
Merge pull request #729 from rdimitrov/dimitrovr/add-dex-docs
...
Add documentation for configuring Supervisor with Dex and Github
2021-07-21 08:48:49 -07:00
Nanci Lancaster
fec59eb1bf
Merge pull request #731 from microwavables/main
...
Removed Andrew Keesler, Pablo Schumaker from site, moved them to emeritus status on maintainers file,
2021-07-20 15:37:04 -07:00
Radoslav Dimitrov
f6273b0604
Update the Prerequisites section and add a note about the groups scope
...
Add Dex to the prerequisites and add a note that to query for the groups
scope the user must set the organizations Dex should search against.
Otherwise the groups claim would be empty. This is because of the format
group claims are represented, i.e. "org:team".
Signed-off-by: Radoslav Dimitrov <dimitrovr@vmware.com>
2021-07-20 13:49:45 +03:00
Radoslav Dimitrov
0bdd1bc68f
Add documentation for configuring Supervisor with Dex and Github
...
The following guide describes the process of configuring Supervisor
with Dex and identify users through their Github account. Issue #415
Signed-off-by: Radoslav Dimitrov <dimitrovr@vmware.com>
2021-07-19 16:00:43 +03:00
Ryan Richard
11eb18d348
ytt install docs suggest that you checkout the release tag
...
Previously, the ytt install docs suggested that you use ytt templates
from the HEAD of main with the container image from the latest public
release, which could result in a mismatch.
2021-07-14 10:59:51 -07:00
Matt Moyer
913c140be8
Update the latest version number in the docs.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-06-15 09:46:51 -05:00
Matt Moyer
02335e2ade
Bump the latest version referenced in the docs.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-06-03 17:25:32 -05:00
Matt Moyer
87660611d2
Tweak blog post to add a shoutout.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-06-02 11:28:54 -05:00
Ryan Richard
a08e4ec043
Update architecture.md
2021-06-02 08:54:04 -07:00
Matt Moyer
e38a7548cc
Link the v0.9.0 release from the blog post.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-06-02 10:24:17 -05:00
Pinny
b5dea42bbe
Update CLI docs for v0.9.0 release
2021-06-02 15:22:13 +00:00
Matt Moyer
e6301f0e74
Update latest version number in docs.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-06-02 10:05:07 -05:00
Matt Moyer
aca33e45fb
Fix blog post date to match actual v0.9.0 release.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-06-02 10:02:59 -05:00
Ryan Richard
8f2e8b8a6c
Merge branch 'main' into ldap_docs
2021-05-28 16:20:02 -07:00
Ryan Richard
cd7f5741d8
Incorporate feedback into LDAP blog post
2021-05-27 14:29:40 -07:00
Ryan Richard
83001d8cce
Fix typo in LDAP blog post
2021-05-27 14:13:07 -07:00
Margo Crawford
f330b52076
Update values.yaml to include CredentialIssuer ImpersonationProxy spec.
2021-05-27 13:36:18 -07:00
Ryan Richard
ec2956d54e
Forgot to mention the CLI in the LDAP blog post
2021-05-27 13:05:45 -07:00
Ryan Richard
0d43105759
Blog post for LDAP release
2021-05-27 12:06:01 -07:00
Ryan Richard
9621ad9d2c
More doc updates
2021-05-26 10:08:03 -07:00
Ryan Richard
bf39f930d4
Some light docs wordsmithing and reordering of the sidebar
2021-05-25 16:15:45 -07:00
Anjali Telang
47582e3290
Documentation for using Jumpcloud as LDAP provider with Pinniped Supervisor
2021-05-25 17:52:32 -04:00
Ryan Richard
f5b11a0239
New docs: 1) Concierge with Supervisor, and 2) Supervisor with OpenLDAP
2021-05-24 19:08:25 -07:00
Matt Moyer
520eb43bfd
Replace all references to "a specific version" with v0.8.0.
...
The documentation was a bit confusing before, and it was easy to accidentally install a very outdated version if you weren't reading carefully.
We could consider writing a post-release CI job to update these references automatically (perhaps using a Hugo macro?), but for now a manual update seems sufficient.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-05-24 11:50:16 -05:00
Matt Moyer
1ab1d41735
Minor cleanups on the new Supervisor+Okta docs page.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-05-24 10:31:06 -05:00
Margo Crawford
36168122cc
Add doc for configuring the supervisor with okta
2021-05-24 10:30:50 -05:00
Pinny
dbde150c38
Update CLI docs for v0.8.0 release
2021-05-10 22:01:16 +00:00
Matt Moyer
f167a075dd
Clean up this language in configure-supervisor-with-gitlab.md a bit more.
...
This was duplicitive.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-05-04 15:49:45 -05:00
Matt Moyer
8136c787a7
More adjustments to configure-supervisor-with-gitlab.md.
...
- Use `nickname` claim as an example, which means we only need the `openid` scope.
This is also more stable since emails can change over time.
- Put the OIDCIdentityProvider and Secret into one YAML blob, since they will likely be copy-pasted together anyway.
- Add a separate section for using alternate claims.
- Add a separate section for using a private GitLab instance.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-05-04 15:49:45 -05:00
Matt Moyer
3e13b5f39d
Do some minor copyediting on "configure-supervisor-with-gitlab.md".
...
Some minor edits I came across while reviewing this:
- Capitalize "GitLab" the way they do.
- Use `{{< ref "xyz" >}}` references when linking internally. The advantage of these is that they're "type checked" by Hugo when the site is rendered, so we'll know if we ever break one.
- Add links to the GitLab docs about creating an OAuth client. These also cover adding a group-level or instance-wide application.
- Re-wrap the YAML lines to fit a bit more naturally.
- Add a `namespace` to the YAML examples, so they're more likely to work without tweaks.
- Use "gitlab" instead of "my-oidc-identity-provider" as the example name, for clarity.
- Re-word a few small bits. These are 100% subjective but hopefully an improvement?
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-05-04 15:49:45 -05:00
Margo Crawford
bed2d2dd62
Incorporated PR feedback
2021-04-28 13:34:36 -07:00
Margo Crawford
96fda6ed13
Added documentation for how to configure the Supervisor with GitLab
2021-04-27 16:18:30 -07:00
Matt Moyer
63816aa3ba
Disable Content-Security-Policy for now.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-04-09 10:58:39 -05:00
Nanci Lancaster
e5314164c5
added search functionality to docs on Pinniped.dev
...
Signed-off-by: Nanci Lancaster <nancil@vmware.com>
2021-04-09 10:58:39 -05:00
Nanci Lancaster
5501b5aa13
Added Ok amba logo for adopters file
2021-04-08 11:48:06 -05:00
Matt Moyer
88c4335b4b
Display blog posts in reverse order by date.
...
This is a minor style tweak.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-04-05 10:54:00 -05:00
Matt Moyer
623830bf1f
Fix a typo on the timezones on the website.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-04-05 10:50:10 -05:00
Pinny
7b82b7a010
Update CLI docs for v0.7.0 release
2021-04-01 19:15:23 +00:00
Matt Moyer
d2a6d7689f
Add a small note about our test grid, and mention some limitations of the first version.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-04-01 13:02:24 -05:00
Matt Moyer
23dbd7cab6
Extract out a common shortcode for the "join the community" blurb we put at the end of each blog post.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-04-01 11:55:17 -05:00
Matt Moyer
e4321cb369
Add v0.7.0 blog post.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-04-01 11:55:17 -05:00
Matt Moyer
ad66f67dc9
Rename existing posts for clarity.
...
This doesn't change the generated HTML at all, as far as I can tell.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-03-31 23:20:48 -05:00
Margo Crawford
6bf8bfe9a8
Merge remote-tracking branch 'origin/main' into impersonation-proxy
2021-03-24 17:22:40 -07:00
Nanci Lancaster
03619fc878
Added kubeapps and vmware tanzu logos
...
these logos will be used for the adopters.md file
2021-03-24 18:03:57 -05:00
Margo Crawford
a537287601
Regenerate cli.md based on output of help message
2021-03-19 14:34:35 -07:00
Margo Crawford
fdfc854f8c
Incorporating suggestions:
...
- a credential that is understood by -> a credential that can be used to
authenticate to
- This is more neutral to whether its going directly to k8s
or through the impersonation proxy
2021-03-19 14:06:20 -07:00
Margo Crawford
331fef8fae
Tweaked some wording, updated the cli page
2021-03-19 14:06:20 -07:00
Margo Crawford
4470d3d2d1
Fix broken links to architecture page
2021-03-19 14:06:20 -07:00
Margo Crawford
698bffc2ad
Naming changes
2021-03-19 14:06:20 -07:00
Margo Crawford
6ff3e42602
Add description of impersonation proxy strategy to docs
2021-03-19 14:06:20 -07:00
Matt Moyer
dd151b3f50
Fix missing titles on website docs.
...
Also fixes our sitemap to have correct `lastmod` times when built locally (it was already correct on Netlify).
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-03-01 11:31:27 -06:00
Matt Moyer
2254f76b30
Fix a broken link, a typo, and tweak menu text.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-02-24 09:23:21 -06:00
Matt Moyer
852c1b7a27
Fix some copy-paste errors on install-supervisor.md.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-02-23 16:02:27 -06:00
Matt Moyer
a4089fcc72
Add security headers to the website.
...
The one bit of JS we have for the mobile menu needed some tweaking.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-02-23 14:38:05 -06:00
Matt Moyer
60034b39a3
Fix wording on website hero text.
...
Requested by @pabloschuhmacher as a small fix.
2021-02-23 12:17:26 -08:00
Matt Moyer
827e6e0dc0
More website tweaks.
...
These are some more changes that came up when Pablo and I were reviewing the previous docs PR.
In no particular order:
- Fix "related posts" on the blog section, and hide the section if there are none.
- Minor style changes to several pages (guided by various style guides).
- Redirect the root of get.pinniped.dev to our main page (shouldn't really be hit, but it's nice to do something).
- Add more mobile-friendly CSS for our docs.
- Reword the "getting started" CTA, and hide it on the docs pages (you're already there).
- Fix the "Learn how Pinniped provides identity services to Kubernetes" link on the landing page.
- Add a date to our blog post cards.
- Rewrite the hero text on the landing page.
- Fix the docs link for the "Get Started with Pinniped" button on the landing page.
- Rework the landing page grid text.
- Add Margo and Nanci to the team section and sort it alphabetically.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-02-23 14:03:37 -06:00
Matt Moyer
7a1d92a8d4
Restructure docs into new layout.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-02-23 11:11:07 -06:00
Matt Moyer
f2db76a0d5
Fix typo in multiple-pinnipeds post.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-02-23 11:11:07 -06:00
Matt Moyer
3721632de2
Move scope doc out of website to SCOPE.md.
...
This is contributor-focused, so we decided to move it into GitHub only for now.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-02-23 11:11:07 -06:00
Matt Moyer
4de949fe18
Rework docs sidebar to have some nesting.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-02-23 11:11:07 -06:00
Matt Moyer
25f841d063
Tweak website styles for accessibility.
...
Makes most of the fonts a bit bigger, increases contrast, fixes some nits about the spacing in numbered/bulletted lists, and adds some image alt texts.
Overall this improves our Lighthouse accessibility score from 71 to 95 and I think it's subjectively more readable.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-02-17 17:19:58 -06:00
Monis Khan
89b00e3702
Declare war on namespaces
...
Signed-off-by: Monis Khan <mok@vmware.com>
2021-02-10 21:52:07 -05:00
Matt Moyer
9c64476aee
Tweak some small bits in the blog post.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-02-04 17:51:35 -06:00
Matt Moyer
b6e98b5783
Update the get.pinniped.dev redirect to always point at the latest version.
...
I messed this up before because the ordering of the path components is a bit different than in the specific version case.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-02-04 17:48:41 -06:00
Matt Moyer
5c331e9002
Fix go.pinniped.dev redirects.
...
Our meeting notes are now on HackMD, our Zoom link changed, and I added a YouTube link.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-02-04 14:56:50 -06:00
Matt Moyer
1382fc6e5f
Add a v0.5.0 "multiple Pinnipeds" blog post.
2021-02-04 14:56:49 -06:00
Nanci Lancaster
2710591429
Updated text on community meetings and added YouTube link
...
Signed-off-by: Nanci Lancaster <nancil@vmware.com>
2021-01-28 11:22:44 -06:00
Matt Moyer
02815cfb26
Revert "Use GitHub's "latest" handling so this doesn't get out of sync."
...
This reverts commit 46ad41e813
.
This turns out not to work, so we have to use a hardcoded version here.
2021-01-28 10:28:46 -06:00
Matt Moyer
46ad41e813
Use GitHub's "latest" handling so this doesn't get out of sync.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-01-28 10:25:33 -06:00
Matt Moyer
d4eca3a82a
Fix get.pinniped.dev latest version redirects.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-01-28 10:23:48 -06:00
Matt Moyer
f81dda4eda
Add syntax highlighting CSS.
...
This was generated via `hugo gen chromastyles --style=monokailight > ./site/themes/pinniped/assets/scss/_syntax.css`.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-01-28 10:15:39 -06:00
Matt Moyer
1ceef5874e
Clean up docs using https://get.pinniped.dev redirects.
...
We have these redirects set up to make the `kubectl apply -f [...]` commands cleaner, but we never went back and fixed up the documentation to use them until now.
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2021-01-28 10:15:39 -06:00
Nanci Lancaster
d6e6f51ced
Add Google Group for meetings
...
Signed-off-by: Nanci Lancaster <nancil@vmware.com>
2021-01-21 14:57:14 -06:00
Margo Crawford
2686031ac1
Fixing documentation to reference 1.20 generated docs
2021-01-08 15:21:23 -08:00
Andrew Keesler
ef74ba7238
Re-export arch diagram to embed images
...
I followed the steps in site/content/docs/img/README.md.
Signed-off-by: Andrew Keesler <akeesler@vmware.com>
2021-01-05 08:44:10 -05:00
Andrew Keesler
b4415a05d0
I don't _think_ we need this picture anymore
...
See f25b4a3
.
Signed-off-by: Andrew Keesler <akeesler@vmware.com>
2021-01-05 08:36:26 -05:00
Margo Crawford
f25b4a3e12
De-duped architecture diagram references
2021-01-04 16:47:34 -08:00
Margo Crawford
8422659ee5
Fixed typos and issues with the demo code
...
- Also cleaned up some wording
2021-01-04 16:23:24 -08:00
Margo Crawford
ef828cf2e1
Add rough draft of supervisor demo
...
Signed-off-by: Andrew Keesler <akeesler@vmware.com>
2021-01-04 15:31:53 -05:00
Margo Crawford
a005b8dce1
Merge branch 'main' into supervisor-docs
2020-12-18 15:34:34 -08:00
Margo Crawford
6cae776e48
Change image reference on README,
...
Also clarified some wording between authenticators and identity providers
2020-12-18 15:09:50 -08:00
Margo Crawford
afc39cd2f7
Tweak image descriptions
2020-12-18 14:54:30 -08:00
Matt Moyer
8313ffcf7f
Add "Installing Pinniped" docs page.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2020-12-18 16:44:20 -06:00
Andrew Keesler
0b12b30cb1
Updated diagrams and architecture text
...
Signed-off-by: Margo Crawford <margaretc@vmware.com>
2020-12-18 14:13:29 -08:00
Matt Moyer
c27d02a929
Fix a typo on the Project Scope page.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2020-12-18 13:48:12 -06:00
Margo Crawford
4dbd8c9cae
Update Concierge-only demo for v0.3.0 release
...
Signed-off-by: Andrew Keesler <akeesler@vmware.com>
2020-12-18 13:06:09 -05:00
Andrew Keesler
40d93ff33b
site/content/docs/architecture.md: another coat of paint with Supervisor updates
...
Signed-off-by: Andrew Keesler <akeesler@vmware.com>
2020-12-18 09:39:36 -05:00
Andrew Keesler
1af06bbcc9
De-dup markdown docs by deleting them in site/ tree
...
I'm not sure if these docs are used anywhere in our website, but I don't think
that they are. I'm assuming someone or something will yell if these should not
be deleted. These docs also live at the root of the repo, and the duplicate
versions are already drifting out of sync from one another.
Signed-off-by: Andrew Keesler <akeesler@vmware.com>
2020-12-18 08:11:14 -05:00
Margo Crawford
2e191084b0
Miscellaneous wording changes
2020-12-17 16:42:45 -08:00
Margo Crawford
28e23e14b5
Demo landing page
2020-12-17 16:08:51 -08:00
Margo Crawford
5f2807e693
Updates to the architecture page.
2020-12-17 15:55:05 -08:00
Rajat Goyal
7e78c9322c
Remove duplicate documentation images from the repo and change all links to point to the Hugo site
2020-12-02 23:58:19 +05:30
Rajat Goyal
31810a97e1
Remove duplicate docs from the repo and change all links to point to the Hugo site
2020-12-02 23:58:19 +05:30
Jake Knostman
15bffc6b16
Update site demo to use pinniped-concierge namespace
2020-11-20 12:31:23 -08:00
jonasrosland
332ed8e50b
Fix landing page use cases
...
Signed-off-by: jonasrosland <jrosland@vmware.com>
2020-11-16 12:00:06 -05:00
Alexander Brand
406d6b5544
docs/scope.md: Fix link to contrib guide
...
Signed-off-by: Alexander Brand <alexbrand09@gmail.com>
2020-11-13 15:25:01 -05:00
Alexander Brand
271640b66d
docs/architecture.md: Fix broken link
2020-11-13 09:17:47 -05:00
Alexander Brand
6b0d4184d5
docs/architecture.md: Fix broken link
2020-11-13 09:15:46 -05:00
Matt Moyer
5fd105496f
Merge pull request #201 from amymanion/am-dev
...
Style updates
2020-11-12 09:12:24 -06:00
Amy Manion
c4ed768c9e
Adjust hero font size
2020-11-12 09:46:44 -05:00
Amy Manion
ef11f97a75
Style updates
...
-adjust font sizes
-fix ordered lists
Signed-off-by: Amy Manion <amy.manion@principlestudios.com>
2020-11-12 09:35:17 -05:00
Jonas Rosland
0b41469527
Website fixes for broken links, formatting, and more
...
Signed-off-by: Jonas Rosland <jrosland@vmware.com>
2020-11-11 21:40:49 -05:00
jonasrosland
e6838ace6b
Add first blog post
...
Signed-off-by: jonasrosland <jrosland@vmware.com>
2020-11-11 17:06:36 -05:00
Matt Moyer
b2b8d5457d
Fix some links on the community page.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2020-11-10 17:19:30 -06:00
jonasrosland
d097de7fdf
Minor website fixes and adding netlify configs
...
Signed-off-by: jonasrosland <jrosland@vmware.com>
2020-11-10 16:03:07 -05:00
Matt Moyer
101394c714
Merge pull request #188 from smalltalk-ai/main
...
Hugo version of Pinniped site
2020-11-10 14:51:45 -06:00
Matt Moyer
f7efc360a0
Add Netlify configs for extra redirect domains.
...
Signed-off-by: Matt Moyer <moyerm@vmware.com>
2020-11-10 13:58:31 -06:00
Amy Manion
ad74f259de
Content updates
...
-remove extra blog posts
-remove extra images
-replace Andrew’s picture
2020-11-10 13:39:13 -05:00
Adam Powell
896e1b45f0
Hugo version of Pinniped site
2020-11-06 12:42:57 -10:00