OpenSauced documentation built with docusaurus
Home Page: http://opensauced.pizza/docs
License: MIT License
We encourage you to contribute to OpenSauced! All contributors are required to abide by our Code of Conduct. Please check out the Contributing guide for guidelines about how to proceed with your contribution.
npm ci
npm startGot Questions? Join the conversation in our Community.
Find OpenSauced videos and release overviews on our YouTube Channel.
MIT © OpenSauced
🍕 Feature
This content is our of date and needs to be update for recommending https://api.opensauced.pizza
Removing all GraphQL mentions ans point users to using the REST api.
No response
This one I will do, just making the issue to remember to do so.
The current Docusuarus version for this repo is 2.0.0-beta.9. Suggest updating to the latest version: 2.2.0.
An update to the site configuration will need to be made to include the Algolia appID prior to updating the Docusaurus version.
I noticed an error in grammar while using the open-sourced contribution docs
This error can be found on the 10th item of the Pull Requests section of the Intro to Contributing guide
Visit the Pull Requests section of the Intro to Contributing Guide. Read through the 10th item on the list.
docs.opensauced.pizza
No response
Chrome
Production
No response
📝 Documentation
Current documentation does not contain head metadata.
https://docusaurus.io/docs/markdown-features/head-metadata
Add and customize head metadata to all markdown files.
No response
🍕 Feature
The favicon is not legible.
To solve this issue, you have to replace the current docs.opensauced.pizza (the one on the left) favicon with the hot.opensauced.pizza (the one on the right) favicon.
Previous issue #65 was meant to fix this and it didn't
Maintainer-level docs are becoming a requirement.
Add maintainer docs category explaining:
Let everyone fail and retry 3-5 years until they become zen masters
Project is now using beta branch as default. There are various mentions in the docs to use the now outdated main branch. Some main mentions may be out of scope and need verification from maintainers
Go to Line 45 in introduction-to-contribution.md you will see main referenced.
There are a number of references to the main branch by searching the repo, want to be clear what needs to be changed and what needs to be kept.
Mentions:
docs.opensauced.pizza
Desktop, Mobile, Tablet
Chrome, Firefox
Production
No response
🍕 Feature
We could use a section for to announce our events and opportunities for contributors and maintainers.
Section named "Community" with a list of links
No response
Seems the discord link in the docs is expired
No response
No response
📝 Documentation
It would be cool to link the git visualizer in the docs.
https://git-school.github.io/visualizing-git/#upstream-changes
No response
Similar to the Chrome extension guide we need user docs in the "Introduction to OpenSauced" section.
🍕 Feature
The favicon is not great and should match the one from hot.opensauced.pizza
The favicon can be found and downloaded from here.
https://github.com/open-sauced/hot/tree/beta/public
No response
The content looks good, I am not everything is place in the correct sections for discoverability.
Today the Contributing and Technical Guide overlap a lot, and the "Welcome page" now includes a highlight, but after considering, it should be separate.
New layout
Start Here
Community
Contributing Guide
I can clean this up after this is merged unless you have time this weekend @CBID2. I am going to be waiting in an airport for awhile and have time.
Originally posted by @bdougie in #103 (comment)
📝 Documentation
https://app.tryeraser.com/workspace/tNZJYK1ryXoLdF7Aziuf
@janie-lee-developer will make a diagram
No response
To fix this, we needs to check for dark mode and swap out the image. You can either right click and download or click the download image button.
https://github.com/open-sauced/assets/blob/main/logos/logo-on-dark.png
This is outline in the docs to do here: https://github.com/open-sauced/docs.opensauced.pizza/blob/main/docusaurus.config.js#L27
the line that should be updated to respect dark mode https://github.com/open-sauced/docs.opensauced.pizza/pull/55/files
docs.opensauced.pizza
No response
No response
No response
https://github.com/open-sauced/docs.opensauced.pizza/blob/main/docusaurus.config.js#L27
📝 Documentation
Current docs mentioned it as an experiement. We need to encourage more contributors to use it.
You can also experiment with conventional commits by doing:
npm run push
Expand on why it is important to the release process.
No response
🎨 Style
In the "Setup" section a first-time contributor might not know (or might appreciate a refresher) on how to fork and clone a repo.
In the "Testing" section it's not stated whether this step applies to the docs, but I don't think it does. Running npm test in this repo gives npm ERR! Missing script: "test", and I don't see any tests in this repo.
In the "Pull Requests" section
The bolded line under the section heading reads "We actively welcome your pull requests, however linking your work to an existing issue is preferred," but item 10 in the instructions below says "Unsolicited code is welcomed, but an issue is required for announce your intentions. PR's without a linked issue will be marked invalid and closed." These are somewhat contradictory, with the first suggesting a linked issue is preferred and the second saying a linked issue is required.
In item 1, some contributors might like a guide to creating branches.
In item 3, how should a contributor decided whether the code they've written should be tested?
In item 5, contributors might benefit from knowing where to store images they'd like to add if there's a particular directory for images, and how to refer to a file in the image directory within the directory in which they're making changes.
In the "Issues" section, the sentence "... please assign yourself by commenting on the following word .take" is maybe slightly confusing.
In the "Funding" section, the link to funding.yml is broken, and seems to possibly not be applicable currently anyway.
Add a link to the GitHub doc on forking and cloning a repo and clarification about changing the link in the codeblock to the contributor's own cloned repo link.
Add clarification, either on how to fix this error, or that this step does not apply to changes made in the docs.opensauced.pizza repo.
This could maybe be rephrased to something like "... please assign yourself by commenting on the issue with .take".
Change or remove the sentence "If you have made any contributions to the projectd directly or indirectly, please consider adding your profile to the funding.yml."
No response
🍕 Feature
We have new brand assets and we will need to update the favicon to the below link.
https://github.com/open-sauced/assets/blob/main/logos/slice-White-Orange.png
The logo will need to be downloaded and renamed and replaced here 👉🏾favicon.ico. You can use a favicon generator to create the multiple sizes
Hacktoberfest contributions welcomed
📝 Documentation
We use the [alpha, beta, main] pattern for all projects and some first contributors can get confused on this.
Create a new doc explaining the difference between the branches and how they work with out automation.
This should be written by a new contributor to capture the beginner context.
The download book link in the footer takes you to a 404
Chrome
No response
Build
workflows are copy pasted from some of the other repositories
centralize and re-use workflows from https://github.com/open-sauced/open-sauced
https://github.com/open-sauced/open-sauced/tree/main/.github/workflows
Similar to the Chrome extension guide we need user docs in the "Introduction to OpenSauced" section.
🍕 Feature
@diivi I think this feature needs some documentation. We are starting to add features that need some explanation.
upvoting - Needs documentation on how and why upvote. Connection to hot.opensauced for see votes is needs an explanation
add to insights dropdown - needs an explanation of insights and the how and why for creating a page.
Your interpretation in the documentation would be great.
Create a guide for hot & insights.
The new algolia config got wiped out in the move.
https://github.com/open-sauced/open-sauced/pull/1121/files
Add the newly added config to this repo.
📝 Documentation
Thinking we should add a link on this in the docs
https://testingjavascript.com/
Something like this
For more info on testing React and JavaScript, check out this course.
https://testingjavascript.com/
No response
Not related to a particular issue but it could fix a couple.
We can extend docusaurus with plugins
Explore both ways:
Have @mtfoley poke me to write "contributing to docs" docs sooner 🎃
Coupling plugins can give us some advantages like:
This is porting open-sauced#1103 to its proper repository
📝 Documentation
Right now there is no category for the API project.
Make a new category for the api repo, and possibly make a new doc page in it called "Getting Started", which guides user through the installation and running the project (probably just clone the readme of the project, but without the extra steps that are not functioning like tests).
Adding the doc page so that the category would not be empty.
No response
I found some Markdown errors in the "Welcome to Community" file. This something I will work on.
N/A
No response
No response
This worked for explore:
npx octoherd-script-copy-labels \
--template "open-sauced/open-sauced" \
-T $GH_TOKEN \
-R "open-sauced/docs.opensauced.pizza" We don't have any labels
maybe @bdougie has some ideas on workarounds if the script doesn't work
📝 Documentation
This question came up during the Octernship assignment a lot, maybe adding an authentication section to the Contributing Guide will help future contributors.
Add the section "Set up Authentication" to the Contributing Guide. This will have the steps that a user can follow to obtain an Auth token from hot.opensauced.pizza.
No response
Feature
Anyone adding a new post or article is not officially credited outside of GitHub contributions
Use metadata to add author information and other social links
No response
The Contributing guide link in the README is broken.
Right now it links to https://github.com/open-sauced/docs.opensauced.pizza/blob/main/CONTRIBUTING.md which gives a 404.
I believe it is supposed to link to either
Click on the link called Contributing guide under 🤝 Contributing in the README.
docs.opensauced.pizza
Desktop, Mobile, Tablet, TV, VR
Chrome, Firefox, Safari, Edge, Opera
Production, Development, Testing
No response
Fast forwarding docs deployment we skipped at least one essential article like "how to add a new document in the docs endpoint".
Potentially have a contributor who's inexperienced with docusaurus add this document portraying their experience and we improve upon it.
Link people to docusaurus and forcing them to become masters of all.
📝 Documentation
Currently there is no category for hot repo.
Make a new category for the hot repo, and possibly make a new doc page in it called "Getting Started", which guides user through the installation and running the project (probably just clone the readme of the project, but without the extra steps that are not functioning like tests).
Similar to the Chrome extension guide we need user docs in the "Introduction to OpenSauced" section.
Select the type of feature request, the lowercase should also be the PR prefix.
The logo font is inter - https://github.com/open-sauced/assets/blob/main/Logos%20/wordmark-Black%20Text.png
Replace this
By submitting this issue, you agree to follow our Code of Conduct.
If you plan on contributing code please read - Contribution Guide
Feature
we are using npm run push with npx cz to create our git conventional commits
implement @open-sauced/conventional-commit as soon as it's officially released
No response
contribution page is showing 404 error.
Link is broken
Visit any of the repos and click the "contributing guide" link
opensauced.pizza, admin.opensauced.pizza, docs.opensauced.pizza
Desktop
Firefox
Production
No response
Style
We only have one logo and no pizza
Add more sauce to the footer, the header and, potentially, the navigation bars.
Announcement bar with a default message would be nice.
No response
Refactor
There are some unneeded files hanging around like .czrc and release.config.js, extraneous .gitattributes even.
Clean up some of these files, update dependencies to latest packages.
No response
📝 Documentation
Since the docs.opensauced is supposed to be the official documentation for all open-sauce repos, having a category with a very general name like "Technical Guide" is very confusing, especially that it focuses mostly on just app.opensauce, without even referencing it.
No response
No response
This is a list of questions I got when presenting at OSCA.
Answers
Documentation
Maintainers section is designed for our tooling and technical debt.
Document @open-sauced/conventional-commit in our docs
No response
https://markprompt.com/docs#docusaurus
I'll add more context later 😀
🍕 Feature
There is no guide on how to use the product and we need the following features explained via gif.
I will work on this for the 100daysofOSS
No response
Documentation
@open-sauced/semantic-release-conventional-config has alphas and betas and it's mostly there
Version 3 is incoming with fully dockerized build and action, one option completely removing the requirement for node and versioned files except the workflow executing the release.
The documentation should reflect and fully explain the convergence between v2 and v3 updates :pizz
blocked until open-sauced/semantic-release-conventional-config#21
Since getting default community files over at open-sauced/.github we are not required to duplicate some of the boilerplate when creating new repositories.
Simplify GitHub documentation for community files and give visual examples for how they are used within @open-sauced
Make everyone silently wonder why things are so cool and just 🤷 often.
📝 Documentation
We need to create documentation for the post to highlight features in the extension.
No response
No response
🍕 Feature
I was looking through the repo's readme file and noticed that there is no mention of the contributors. It can cause them to feel disheartened.
My colleague Josh Goldberg has created a GitHub Action that automatically posts contributors if they raise an issue or get their PR merged. I've seen it in action(no pun intended) and it's pretty effective productivity-wise.
No response
When clicking the repository display settings (top right cog icon as a repository admin), the URL field is empty.
Fill out the URL input with the default value http://open-sauced.github.io/docs.opensauced.pizza and let the CNAME do its course.
Think only @bdougie can do that?
Ping maintainers team for more information
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.
