-
Notifications
You must be signed in to change notification settings - Fork 41
General Notes on Editing Pages
If you are involved in the initial development, you may make commits directly to the staging branch. Once we are in production, We will ask that folks fork the repo and then submit PRs against staging so that we can properly review and test them.
The site uses a combination of tsx (Typescript), md (Markdown), and yaml (Yet Another Markdown Language) files.
If you are editing one of the pages or blog posts that is also able to be managed by the CMS, it is an md file located in src/content/pages or src/content/articles and can only include Markdown formatting. These files must also include the appropriate frontmatter section. Please see one of the exiting pages or blog posts to see what you need to include. More information about the components of these pages can be found in the Routine Editing section. If you are unfamiliar with Markdown, please see:
https://www.markdownguide.org/
yaml files are in YAML syntax and are stored in /src/data/yaml (except the featured addons, which are stored in `src/data/addons//featured.yaml). These files contain the data that help build the distribution, sponsor, and store pages.
tsx files are in React and are used for the templates, section widgets, and components as well as some of the complex pages. If you are editing one of those files, please make sure you know what you're doing. If you provide the incorrect React syntax for something, the site will fail to build.
We are using TailwindCSS for layout, so if you need to do any formatting that can't be handled with Markdown, you will need to import the appropriate Patternfly JSX modules for us. For more information about TailwindCSS, please see:
We also have a license for a set of pre-built sections and widgets. Those are available at:
The login information for the TailwindUI site is in the Team 1Password vault.