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

Add browser template docs #43

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Conversation

meyerjrr
Copy link
Contributor

In this PR I also updated the configuration docs to be separated out into different pages to help with discoverability

--console --exec --pass-through --un --verbose -e -u
```

Type `assume -s ` and press **tab** to see service names.
Copy link
Contributor

Choose a reason for hiding this comment

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

is there something required to enable this? I've run granted completion -s zsh but it doesn't seem to work

Copy link
Contributor

@chrnorm chrnorm left a comment

Choose a reason for hiding this comment

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

I think we should split this into two separate PRs: one to add the browser template guide and a second PR to improve our config docs.

I'm not sure if the approach in this PR of splitting the config page up into a subfolder is ideal. We currently have a "Usage" section and a "Recipes" section. A lot of the content in the Config section may be better placed inside of "Usage"? (and we should consider removing Recipes, perhaps?)

What I'd propose we do instead is reduce the content in the configuration page, and have it just focused on the ~/.granted/config file. e.g. we should show an example config, and explain what each section in the config does. Everything else should be shifted to Usage.

granted/configuration.mdx Outdated Show resolved Hide resolved
granted/configuration/misc.mdx Outdated Show resolved Hide resolved
@meyerjrr
Copy link
Contributor Author

Thanks @chrnorm good feedback. I have altered the change to move all the new pages to under the usage folder + removed the recipes section and moved those pages to under usage as well.

I think this is much easier to find all the usage features in one place

Another thing I was thinking was making integrations with Common Fate easier to find. There has been a couple times where users were unable to find the relevant documentation and resorted to asking us directly.
I have moved these under in a subfolder, and added documentation for creating profiles with the HTTP registry feature
Screenshot 2024-09-25 at 5 33 11 PM

Keen for your thoughts here. Happy to scrap it / move it into a separate PR if you'd like that as well.

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

Successfully merging this pull request may close these issues.

3 participants