docs.px.dev ·

This repo contains the source code and content for the Pixie Docs website.

Reporting Issues

Submit any issues or enhancement requests by filing an issue. Please search for and review the existing open issues before submitting a new issue.

Contributing

We're excited to have you contribute to Pixie's documentation!

Pixie has adopted the Contributor Covenant as its code of conduct, and we expect all participants to adhere to it. Please report any violations to [email protected]. All code contributions require signing, please refer to the Contribution Guide.

Dev Setup

To run in development mode, run the following commands:

yarn install
yarn start

Then visit http://localhost:8000/ to view the app.

To generate a production build, run:

yarn install
yarn build

Adding New Language Translations

1. Create a new empty folder in the content folder. Name the folder with the new language's 2-letter code.
2. Add a new item for the new language to the languages list in the available-languages.js file.
3. Copy the file you want to translate from the en folder into the new folder. Make sure to maintain the same folder structure, folder names, and file name as the en directory.
4. Translate the file and create a PR.

Updating Automated Content

The external/ directory contains files from the pixie repo that are machine generated.

There is automation that updates the external/pxl_documentation.json file automatically, while the datatable_documentation.json file must be manually updated.

Deploy Previews

Once you submit a pull request to this repo, Netlify creates a deploy preview for the changes in the specific PR. You can view the deploy preview in the Netlify panel that appears under the PR description.

Publishing the Site

The Pixie website is published automatically by Netlify. Whenever changes are merged into the prod branch, Netlify re-builds and re-deploys the site.

Documentation License

This work is licensed under a Creative Commons Attribution 4.0 International License.

Please note the Creative Commons Attribution 4.0 license applies to the creative work of this site (documentation, visual assets, etc.) and not to the underlying code and does not supersede any licenses of the source code, its dependencies, etc.