mirror of
https://github.com/Unleash/unleash.git
synced 2024-10-28 19:06:12 +01:00
f09d184eb2
<!-- Thanks for creating a PR! To make it easier for reviewers and everyone else to understand what your changes relate to, please add some relevant content to the headings below. Feel free to ignore or delete sections that you don't think are relevant. Thank you! ❤️ --> ## About the changes <!-- Describe the changes introduced. What are they and why are they being introduced? Feel free to also add screenshots or steps to view the changes if they're visual. --> A new Python Examples doc: - underneath Python tutorials - explores more use cases for Python with feature flags in Unleash, building on top of our existing Python tutorial. - This was edited and reviewed by team members via [Google Docs](https://docs.google.com/document/d/1gO5KSShCKObbdjP-TobIjaOLqTP5_V1YcTLXAp5DA2g/edit#heading=h.oblpm3ljyzs8) before adding to our docs site. - Python Tutorial links to this doc as a continuation <img width="1502" alt="Screenshot 2024-01-31 at 11 44 28 AM" src="https://github.com/Unleash/unleash/assets/22972707/86aec6a5-9483-41a8-bd65-ae0fcf7d7c7f"> <!-- Does it close an issue? Multiple? --> Closes # <!-- (For internal contributors): Does it relate to an issue on public roadmap? --> <!-- Relates to [roadmap](https://github.com/orgs/Unleash/projects/10) item: # --> ### Important files <!-- PRs can contain a lot of changes, but not all changes are equally important. Where should a reviewer start looking to get an overview of the changes? Are any files particularly important? --> `website/docs/feature-flag-tutorials/python/examples.md` ## Discussion points <!-- Anything about the PR you'd like to discuss before it gets merged? Got any questions or doubts? --> --------- Co-authored-by: Nuno Góis <github@nunogois.com> |
||
---|---|---|
.. | ||
img | ||
.nojekyll | ||
CNAME | ||
README.md | ||
robots.txt |
The Unleash website was created with Docusaurus. The source code lives as part of the main Unleash repo on GitHub and is built and deployed on all merges to main. This makes it easy to keep the documentation in sync with the latest version of Unleash.
It's hosted on https://docs.getunleash.io
What's In This Document
Get Started in 5 Minutes
- Make sure all the dependencies for the website are installed:
# Install dependencies
$ npm install
- Run your dev server:
# Start the site
$ npm run start
Directory Structure
Your project file structure should look something like this
unleash/
website/
/docs
doc-1.md
doc-2.md
doc-3.md
static/
css/
img/
package.json
sidebar.json
docusaurus.config.js
Editing Content
Editing an existing docs page
Edit docs by navigating to docs/
and editing the corresponding document:
docs/doc-to-be-edited.md
---
id: page-needs-edit
title: This Doc Needs To Be Edited
---
Edit me...
For more information about docs, click here
Adding Content
Adding a new docs page to an existing sidebar
- Create the doc as a new markdown file in
/docs
, exampledocs/newly-created-doc.md
:
---
id: newly-created-doc
title: This Doc Needs To Be Edited
---
My new content here..
- Refer to that doc's ID in an existing sidebar in
website/sidebars.json
:
// Add newly-created-doc to the Getting Started category of docs
{
"docs": {
"Getting Started": [
"quick-start",
"newly-created-doc" // new doc here
],
...
},
...
}
For more information about adding new docs, click here
Adding items to your site's top navigation bar
- Add links to docs, custom pages or external links by editing the headerLinks field of
website/siteConfig.js
:
website/siteConfig.js
{
headerLinks: [
...
/* you can add docs */
{ doc: 'my-examples', label: 'Examples' },
/* you can add custom pages */
{ page: 'help', label: 'Help' },
/* you can add external links */
{ href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
...
],
...
}
For more information about the navigation bar, click here
Full Documentation
Full documentation can be found on the website.