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

Update Writers Guide #383

Closed
BekahHW opened this issue Aug 29, 2024 · 8 comments · Fixed by #397
Closed

Update Writers Guide #383

BekahHW opened this issue Aug 29, 2024 · 8 comments · Fixed by #397
Assignees

Comments

@BekahHW
Copy link
Member

BekahHW commented Aug 29, 2024

Now that we've updated to the latest version of docusaurus, there are some directions that need to be updated here:

https://opensauced.pizza/docs/contributing/opensauced-writers-guide/writers-guide/.

The biggest change is with the authors.yml file. Let's update this based on the docusuarus documentation.

@shubhamchasing
Copy link
Contributor

Hey @BekahHW, I would like to contribute to docs. Can you please assign me? This would be my first contribution to docs!

@shubhamchasing
Copy link
Contributor

.take

Copy link
Contributor

Thanks for taking this on! If you have not already, join the conversation in our Community

@shubhamchasing
Copy link
Contributor

Is this example fine, what else should I include in the example
Screenshot from 2024-09-16 18-27-03

In the update 3.5 there are other updates like

Please help me with what changes I should make, thank you!

@BekahHW
Copy link
Member Author

BekahHW commented Sep 19, 2024

@shubhamchasing great questions! Let's just add an admonition in the repeat authors section like this:

:::note

Please be sure to add  `page: true` to your author entry to generate your author page.
:::

In terms of the example, why don't we go with the first two entries in our current authors.yml file.

@shubhamchasing
Copy link
Contributor

@BekahHW anything else is required?
As you suggested, I included an admonition and all the details for the first entry, as well as some details from the second entry to keep the example concise authers. yml

Screenshot from 2024-09-20 20-37-31

@BekahHW
Copy link
Member Author

BekahHW commented Sep 20, 2024

That looks good to me, @shubhamchasing

@shubhamchasing
Copy link
Contributor

That looks good to me, @shubhamchasing

I have one query, I tried to find the dedicated author page like slorber but I could not find it, where can I find it?

shubhamchasing added a commit to shubhamchasing/open-sauced-docs that referenced this issue Sep 20, 2024
BekahHW pushed a commit that referenced this issue Sep 25, 2024
docs: update authors guide with Docusaurus 3.5 changes (#383)
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 a pull request may close this issue.

2 participants