-
Luke Edwards authored* import migrate directory * create _index.html & docs.html * move products -> content * migrate docs-configs -> data yaml * initial code style * remove docs-engine content * normalize; fix links, images, frontmatter * mdx -> hugo partials * rewrite partial & component imports * rename list pages to _index.md * import robots.txt file * rm -rf products * import static content files * import assets directory * import layouts directory * import config.toml file * import .vscode dir * update root files * update github actions * import Pages build scripts * remove migrate directory * remove component dirs * remove website dir * manual: import content-table page layout w/ overrides * manual: fix runtime-api html markup * manual: whitespace for quickstarts * manual: update example pages * manual: update root files * manual: update pages tutorial layout * manual: import stylesheets * manual: fix layout, sidebar, pages-images * manual: remove duplicate `content/*/images` files * fix(sidebar): render expanded subnav when section-index active; - example: /workers/platform/ - example: /workers/platform/sites/ * manual: ensure correct product names in sidebar * fix(sidebar): ensure "/examples/" pages not in sidebar * manual: import icons, favicon, & manifest * manual: valid og:image asset paths * fix(theme): only auto-detect system theme if no lcs value * fix(events): handle focus attrs for topbar search inputs * fix: attach `home.ts` script to `home` layout * manual: misc formatting fixes * fix(highlight): find/render indented code snippets * chore: file perm changes post-build * updating image paths * manual: code formatting updates; - add code fences if missing - remove useless trailing newline * fix links in headers * manual: more `highlight` code normalization; - allow `content/images` directory to be highlighted * convert link to markdown for styling * Override layout for DDOS landing pages * manual: generate `sponsorships.html` page * manual: feedback batch * fix theme button * fix(theme): operation ordering, oops * chore: save format output Co-authored-by:
Jon Kuperman <jon.kuperman@gmail.com>Luke Edwards authored* import migrate directory * create _index.html & docs.html * move products -> content * migrate docs-configs -> data yaml * initial code style * remove docs-engine content * normalize; fix links, images, frontmatter * mdx -> hugo partials * rewrite partial & component imports * rename list pages to _index.md * import robots.txt file * rm -rf products * import static content files * import assets directory * import layouts directory * import config.toml file * import .vscode dir * update root files * update github actions * import Pages build scripts * remove migrate directory * remove component dirs * remove website dir * manual: import content-table page layout w/ overrides * manual: fix runtime-api html markup * manual: whitespace for quickstarts * manual: update example pages * manual: update root files * manual: update pages tutorial layout * manual: import stylesheets * manual: fix layout, sidebar, pages-images * manual: remove duplicate `content/*/images` files * fix(sidebar): render expanded subnav when section-index active; - example: /workers/platform/ - example: /workers/platform/sites/ * manual: ensure correct product names in sidebar * fix(sidebar): ensure "/examples/" pages not in sidebar * manual: import icons, favicon, & manifest * manual: valid og:image asset paths * fix(theme): only auto-detect system theme if no lcs value * fix(events): handle focus attrs for topbar search inputs * fix: attach `home.ts` script to `home` layout * manual: misc formatting fixes * fix(highlight): find/render indented code snippets * chore: file perm changes post-build * updating image paths * manual: code formatting updates; - add code fences if missing - remove useless trailing newline * fix links in headers * manual: more `highlight` code normalization; - allow `content/images` directory to be highlighted * convert link to markdown for styling * Override layout for DDOS landing pages * manual: generate `sponsorships.html` page * manual: feedback batch * fix theme button * fix(theme): operation ordering, oops * chore: save format output Co-authored-by:Jon Kuperman <jon.kuperman@gmail.com>
After you've reviewed these contribution guidelines, you'll be all set to
contribute to this project.
CONTRIBUTING.md 2.44 KiB
Contributing to Cloudflare's Documentation
Issues
Open an issue when something in the content is incorrect, out-of-date, or if the documentation doesn’t match the actual functionality. The items below are covered in our issue template.
- What is the expected behavior?
- Link to the documentation or explain the expected outcome of following the documentation.
- What is the actual behavior?
- Explain what actually happens when you follow the documentation.
- Which part of the documentation requires an update?
- Provide a link to the page that needs an update and be specific about which section requires the update.
- Additional information
- Any other details or screenshots you think are relevant.
- Issue Labels
Pull Requests
Before proposing significant changes, open an issue so that we can discuss your approach first. Only members of the Cloudflare organization can open a pull request on the repository, and they should follow the same guidance on opening an issue for significant changes. If you’re not part of the Cloudflare organization but want to contribute, fork the repository and then create a pull request.
Pull Request Guidelines
- Commits and commit messages
- Use smaller commits for your work to make it easier to review. In your commit messages, be specific about what you changed in the files.
- Pull request titles
- Follow the title structure of [Product Name]+ work you did + affected file(s)
- Example: [Access] fix broken link in example_file.md
- Pull request descriptions
- Use bullet points to summarize the changes in the commits
- Add any other information you think is helpful or needs addressed. If your PR fixes an open issue, indicate that your PR is addressing the issue and provide a link to the issue.
Package manager
- Yarn is the recommended package manager that must be used in installing dependencies.
- Generated yarn.lock files must be committed to git.
A member of the Product Content Experience team will review the pull request. If the changes are straightforward, the pull request is approved and can be merged. If the pull request is more technical and requires an additional review, the new reviewer will leave any additional feedback. If a pull request is not approved, the “won't fix” label is applied and a comment is added to explain why the pull request was closed.