-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add admin configuration docs and user access #95
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
Conversation
|
Surge PR preview deployment succeeded. View it at https://ricochet-rs-docs-pr-95.surge.sh |
pat-s
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd like to discuss two high-level topics on the base of this PR:
-
Whether to move forward with the "you" style or not.
Right now many sections are written as "Add the following to your
ricochet-config.toml:" whereas it could also be "Add the following toricochet-config.toml:".I personally favor the latter. It reads more "professional" and less "like a friend" style and also avoids many "you|yours" etc words which don't change the sentence meaning.
-
"One sentence per line": I know this is and will forever be a philosophical task but I am one of these persons who strongly believes markdown should be written that way. It helps with reviewing a lot and avoids long line and leads to a good reading flow (of the source). Line breaks don't change the markdown alignment, only adding two empty spaces at the end of a line forces a real line break. To me it makes a lot of sense to hit "enter" after a dot and continue with the next sentence :)
| A **task** is one that runs to completion such as R/Julia scripts and Quarto documents. | ||
| A **Task** runs to completion such as R/Julia/Python scripts and Quarto documents. | ||
|
|
||
| All tasks can be [scheduled](/v0-1/user/content-items/4-scheduled-content) (or [invoked via API](/v0-1/user/tasks/1-invoke)). A subset of tasks can be served as a [**static html** website](/v0-1/user/content-items/3-static-content)—for example R Markdown and Quarto documents or websites. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A Task runs to completion such as R/Julia/Python scripts and Quarto documents.
All tasks can be scheduled (or invoked via API).
A subset of tasks can be served as a static html website—for example R Markdown and Quarto documents or websites.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think a suggestion may have been messed up here
src/content/docs/v0-1/user/content-items/1-content-items-overview.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/v0-1/user/managing-content/1-access-and-permissions.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/v0-1/user/managing-content/1-access-and-permissions.mdx
Show resolved
Hide resolved
|
|
||
| ## Setting Access and Permissions | ||
|
|
||
| 1. Navigate to your item's settings page |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use Astro <Steps> component for such parts
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You need line breaks between the items to make it look "good".
|
I am a-okay not using 2nd person. I will not be able to perfect a one line per sentence in markdown. That's nearly 2 decades of typing behavior :/ I can try but it shouldn't prevent merging. If we we can make will address requested edits |
Alright, I understand that! Please see if #101 works for you! |
|
@pat-s mind giving this another once over? Changes should be taken into account here. Feel free to make any changes you see fit. Though, I think the editorconfig lint needs to be adjusted. It's showing an issue with the number of spaces in the quickstart. But looking at this should pass the lint check |
|
Editorconfig is correct. Indent here was at 3 (instead of 4). It doesn't align visually with numbered lists. |
|
@JosiahParry I've cleaned up and make various QOL improvements:
Should have probably done these in a separate PR but here we are now 👀 Please have a look whether this looks good to you! |
|
@pat-s looks good for me! Do you want to merge it? |

Update docs
New docs
Admin Docs
User Docs