Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(Auto) Sync main-to-development #1

Open
wants to merge 11 commits into
base: development
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 53 additions & 63 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,79 +1,69 @@
# Default site owners
# These owners will be requested for review unless a later match takes precedence.
* @o3de/sig-docs-community-maintainers

# Ownership owners
/.github/CODEOWNERS @o3de/sig-chairs
/.github/CODEOWNERS @o3de/sig-docs-community-maintainers

# Default owner directories
# These directories have default owners and also exceptions that will be specified in later groups.
/content/docs/ @o3de/sig-docs-community-reviewers
/layouts/ @o3de/sig-docs-community-site-reviewers
/static/images/ @o3de/sig-docs-community-reviewers

# Should not be modified in development
/content/docs/release-notes/* @o3de/sig-chairs
/static/images/release-notes/* @o3de/sig-chairs
/content/blog/* @o3de/sig-chairs
/static/images/blog/* @o3de/sig-chairs
/CONTRIBUTING @o3de/sig-chairs
/README.md @o3de/sig-chairs
# Website content
/assets/ @o3de/sig-docs-community-site-reviewers
/content/search/ @o3de/sig-docs-community-site-reviewers
/static/js/ @o3de/sig-docs-community-site-reviewers
/config.toml @o3de/sig-docs-community-site-reviewers
/Makefile @o3de/sig-docs-community-site-reviewers
/netlify.toml @o3de/sig-docs-community-site-reviewers
/package.json @o3de/sig-docs-community-site-reviewers

# Community content
/content/blog/_index.md @o3de/sig-docs-community-reviewers
/content/community/* @o3de/sig-docs-community-reviewers
/content/contribute/* @o3de/sig-docs-community-reviewers
/content/docs/contributing/* @o3de/sig-docs-community-reviewers
/static/images/community/* @o3de/sig-docs-community-reviewers
/static/images/contribute/* @o3de/sig-docs-community-reviewers
/static/images/contributing/* @o3de/sig-docs-community-reviewers
/static/images/shared/* @o3de/sig-docs-community-reviewers
/layouts/blog/* @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/layouts/partials/blog/* @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/layouts/community/* @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/layouts/contribute/* @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/layouts/partials/community/* @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/layouts/partials/contribute/* @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/content/blog/ @o3de/sig-docs-community-reviewers
/content/community/ @o3de/sig-docs-community-reviewers
/content/contribute/ @o3de/sig-docs-community-reviewers
/layouts/blog/ @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/layouts/community/ @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/layouts/contribute/ @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/layouts/partials/blog/ @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/layouts/partials/community/ @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/layouts/partials/contribute/ @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/layouts/partials/blog-display.html @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/layouts/partials/css.html @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/static/images/blog/ @o3de/sig-docs-community-reviewers
/static/images/community/ @o3de/sig-docs-community-reviewers
/static/images/contribute/ @o3de/sig-docs-community-reviewers
/CONTRIBUTING.md @o3de/sig-docs-community-reviewers
/README.md @o3de/sig-docs-community-reviewers

# Docs content - Owned by SIG-docs-community on development
/content/smoketest.md @o3de/sig-docs-community-reviewers
/static/_redirects @o3de/sig-docs-community-reviewers
# Release content
/content/docs/release-notes/ @o3de/sig-docs-community-maintainers @o3de/sig-release-maintainers
/static/images/release-notes/ @o3de/sig-docs-community-maintainers @o3de/sig-release-maintainers

# Docs content
/content/docs/* @o3de/sig-docs-community-reviewers
/content/docs/engine-dev/* @o3de/Reviewers
/static/docs/* @o3de/sig-docs-community-reviewers
/static/images/api-reference/* @o3de/sig-docs-community-reviewers
/static/images/atom-guide/* @o3de/sig-docs-community-reviewers
/static/images/contribute/* @o3de/sig-docs-community-reviewers
/static/images/contributing/* @o3de/sig-docs-community-reviewers
/static/images/learning-guide/* @o3de/sig-docs-community-reviewers
/static/images/shared/* @o3de/sig-docs-community-reviewers
/static/images/tools-ui/* @o3de/sig-docs-community-reviewers
/static/images/user-guide/* @o3de/sig-docs-community-reviewers
/static/images/welcome-guide/* @o3de/sig-docs-community-reviewers
/static/images/icons/* @o3de/sig-docs-community-reviewers
/layouts/shortcodes/* @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/layouts/docs/* @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/layouts/partials/docs* @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/content/smoketest.md @o3de/sig-docs-community-reviewers
/static/docs/ @o3de/sig-docs-community-reviewers
/static/files/ @o3de/sig-docs-community-reviewers
/static/_redirects @o3de/sig-docs-community-reviewers
/layouts/shortcodes/ @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/layouts/docs/ @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers
/layouts/partials/docs @o3de/sig-docs-community-reviewers @o3de/sig-docs-community-site-reviewers

# Web content
/assets/* @o3de/sig-docs-community-site-reviewers
/layouts/* @o3de/sig-docs-community-site-reviewers
/content/search/* @o3de/sig-docs-community-site-reviewers
/static/js/* @o3de/sig-docs-community-site-reviewers
/config.toml @o3de/sig-docs-community-site-reviewers
/Makefile @o3de/sig-docs-community-site-reviewers
/package.json @o3de/sig-docs-community-site-reviewers
# Shared community and docs content
/content/docs/contributing/ @o3de/sig-docs-community-reviewers
/content/docs/contributing/to-code/ @o3de/sig-docs-community-reviewers @o3de/reviewers
/static/images/contributing/ @o3de/sig-docs-community-reviewers

# Foundation-owned materials
/content/download/* @o3de/lf
/content/download/ @o3de/lf
/content/_index.md @o3de/lf
/LICENSE-* @o3de/lf
/_index.md @o3de/lf
/netlify.toml @o3de/lf
/static/apple-touch-icon-114x114.png @o3de/lf
/static/apple-touch-icon-120x120.png @o3de/lf
/static/apple-touch-icon-144x144.png @o3de/lf
/static/apple-touch-icon-152x152.png @o3de/lf
/static/apple-touch-icon-180x180.png @o3de/lf
/static/apple-touch-icon-57x57.png @o3de/lf
/static/apple-touch-icon-72x72.png @o3de/lf
/static/apple-touch-icon-76x76.png @o3de/lf
/static/apple-touch-icon.png @o3de/lf
/static/images/events/ @o3de/lf
/static/images/home/ @o3de/lf
/static/img/ @o3de/lf
/static/video/ @o3de/lf
/static/apple-touch-icon*.png @o3de/lf
/static/favicon.ico @o3de/lf
/static/img/* @o3de/lf
/static/images/events/* @o3de/lf
/static/images/home/* @o3de/lf
1 change: 0 additions & 1 deletion config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ unsafe = true

[params]
font_awesome_version = "5.12.0"
mermaid_version = ["9.2.2", "sha384-W/RuUCsZGwf4MwkS0K4JdFzoA0RgiA6foiYzRo68rW5DNPfq+5Dr0uGKY1zecHEA"]
description = "Open 3D Engine (O3DE) is a modular, open source, cross-platform 3D engine built to power anything from AAA games to cinema-quality 3D worlds to high-fidelity simulations. No fees or commercial obligations. Apache 2.0-licensed. Managed by The Linux Foundation."
favicon = "favicon.ico"
repositoryUrl = "https://github.com/o3de/o3de.org"
Expand Down
6 changes: 3 additions & 3 deletions content/docs/contributing/to-docs/hugo.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,13 +157,13 @@ Within a layout directory, Hugo looks for one of 4 basic types:
* `baseof.html`: The "base" template. Do not override this unless you know what you're doing!
* `section.html`: The template for `_index.md` files, or section homepages.
* `single.html`: The template for files in a directory which are _not_ `_index.md` files – i.e., regular pages.
* `list.html`: The templae for lists of subpages. As this gets a bit confusing with `section.html`, only use this layout for blog sections.
* `list.html`: The template for lists of subpages. As this gets a bit confusing with `section.html`, only use this layout for blog sections.

Most of the top level pages in the O3DE site are `section.html` pages with no subpages.

#### Understanding Hugo layout inheirtance
#### Understanding Hugo layout inheritance

As described above, Hugo looks for progressively more specific layouts and applies the most specific one it can find. However, it also does this _within_ layout files by allowing you to overide a section called `main`.
As described above, Hugo looks for progressively more specific layouts and applies the most specific one it can find. However, it also does this _within_ layout files by allowing you to override a section called `main`.

For example, let's look at `/layouts/_default/baseof.html`:

Expand Down
1 change: 0 additions & 1 deletion content/docs/contributing/to-docs/style-guide/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ What are the ideal traits for O3DE docs?
- [Quick Reference](./quick-reference) - A quick reference of common style guide rules.
- [Writing Guidelines](./guidance) - Guidance on our documentation style, tone, and how to write in an accessible manner.
- [Formatting Guidelines](./format) - Specific rules regarding formatting and typesetting our documentation, such as how to format executable names, file paths, and code blocks. Covers the features available in the variant of Markdown that the O3DE docs site uses.
- [Formatting Tools](./tools) - A list of the tools that can assist with the specialized formatting needs of some O3DE documentation.
- [Metadata](./metadata) - Details on the available (and required) Hugo front matter metadata to use in the [YAML](https://yaml.org/) headers of Markdown files.
- [Shortcodes](./shortcodes) - The Hugo shortcodes that we use for the O3DE docs. Includes call-out boxes, version numbers, static paths that O3DE uses, and other useful tidbits.
- [Submitting Media](./media) - Guidelines for submitting media (images, video, audio, or assets) to the docs.
Expand Down
4 changes: 2 additions & 2 deletions content/docs/contributing/to-docs/style-guide/media.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Guide-specific images, such as interface screenshots and diagrams, are located i
In order to standardize presentation, and to keep the O3DE documentation repository below 1 GB, please adhere to the following guidelines when you create images for documentation:

* Text in images should follow our style guidelines without formatting requirements.
* Do not include personal identification information (PII) in your screenshots. PII includes, but it not limited to, names, geographic information, project names, IP addresses, DNS names, and directory paths. We recommend you crop out areas of images that might contain PII and that you create projects specifically for documentation contributions that do not expose PII. Using common image filters to blur or disguise PII is not recommended as they can sometimes be reversed. To remove PII from an image:
* Do not include personal identification information (PII) in your screenshots. PII includes, but is not limited to, names, geographic information, project names, IP addresses, DNS names, and directory paths. We recommend you crop out areas of images that might contain PII and that you create projects specifically for documentation contributions that do not expose PII. Using common image filters to blur or disguise PII is not recommended as they can sometimes be reversed. To remove PII from an image:

1. In any image editor, draw a rectangle selection box around the PII.

Expand Down Expand Up @@ -128,7 +128,7 @@ Due to limitations on repository size, animated `.gif` images are not accepted i

### Image strips

To demonstrate steps, consider using horizontal two to four panel annotated image strip that demonstrates the start, action, and result of the process. See the example below:
To demonstrate steps, consider using a horizontal two to four panel annotated image strip that demonstrates the start, action, and result of the process. See the example below:

{{< image-width "/images/contributing/to-docs/image-strip-example.png" "700" "An image strip example with two panels." >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 150
toc: true
---

Follow the **Open 3D Engine (O3DE)** Docs Style Guide in your documentation. This ensures that the documentation is consistent and helpful to users.
Follow the O3DE Docs Style Guide in your documentation. This ensures that the documentation is consistent and helpful to users.

| **Language** | |
| --- | --- |
Expand All @@ -18,7 +18,7 @@ Follow the **Open 3D Engine (O3DE)** Docs Style Guide in your documentation. Thi
| [Acronyms, abbreviations, and Latin phrases](guidance#acronyms-abbreviations-and-latin-phrases) | Write acronyms or abbreviations in their expanded form first, followed by the acronym in parentheses. Don't abbreviate common words or use Latin phrases; use the complete word or a similar one. |
| [Idioms, slang, colloquialisms, or jargon](guidance#idioms-slang-colloquialisms-or-jargon) | Don't use them. These words and phrases may be understood by native U.S. English speakers, but are difficult to translate. |
| **Formatting** |
| [Hugo](../hugo) and [Markdown](format) | Documentation is written in Markdown (`.md`) files and built by [Hugo](https://gohugo.io/), a static site generator. It's primarily formatted using [Markdown syntax](https://www.markdownguide.org/basic-syntax/), with support for in-line HTML. Additional content formatting includes images, videos, callout boxes, math equations, and diagrams. Callout boxes are implemented through [shortcodes](shortcodes). Math equations can be rendered using [MathJax formatting](tools#math-formulas). Diagrams can be rendered using [Mermaid syntax](tools#diagrams) inside Markdown code blocks. |
| [Hugo](../hugo) and [Markdown](format) | Documentation is written in Markdown (`.md`) files and built by [Hugo](https://gohugo.io/), a static site generator. It's primarily formatted using [Markdown syntax](https://www.markdownguide.org/basic-syntax/), with support for in-line HTML. Additional content formatting includes images, videos, and callout boxes. Callout boxes are implemented through [shortcodes](shortcodes). |
| [Metadata](metadata) | Documentation must comply with metadata requirements, including *linktitle*, *title*, and *description*. Use *weight* to override the default alphabetical sort order. |
| [Topic headings](format.md#topic-headings) | Section titles must use H2 (`##`) headings. Subsection titles follow as H3 (`###`) and H4 (`####`) headings. Topic headings must use sentence case. The H1(`#`) heading is reserved for the page title which is specified in the topic's metadata. |
| [User interface, inputs, and hotkeys](format#user-interface-inputs-and-hotkeys) | Bold all instances. |
Expand Down
102 changes: 0 additions & 102 deletions content/docs/contributing/to-docs/style-guide/tools.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The workflow:

7. [Submit your document to O3DE Documentation.](#submit-your-component-reference-document)

All documentation must adhere to the standards outlined in the O3DE [Style Guide](/docs/contributing/to-docs/style-guide/)and [Terminology](/docs/contributing/to-docs/terminology/). If you need any help, reach out to the Documentation and Community Special Interest Group (#sig-docs-community) on [Discord](https://discord.com/invite/o3de).
All documentation must adhere to the standards outlined in the O3DE [Style Guide](/docs/contributing/to-docs/style-guide/) and [Terminology](/docs/contributing/to-docs/terminology/). If you need any help, reach out to the Documentation and Community Special Interest Group (#sig-docs-community) on [Discord](https://discord.com/invite/o3de).


## Does my document belong in the O3DE Component Reference?
Expand Down Expand Up @@ -257,7 +257,7 @@ For a component card with a complex set of properties, you may need multiple pro
Another option is to separate the property tables into [tabs](/docs/contributing/to-docs/style-guide/format/#tabs) on your document. When content is in tabs, only the active tab displays content, while the rest is hidden. Because of this behavior, tabs are recommended if the sets of properties define configurations for different workflows that the user may or may not choose.

**Examples**:
* [Light component](/docs/user-guide/components/reference/atom/light/): Contains several configurations that don't have a 1-1 relationship with the **Light type** property. Some propery groups are available for more than one light type, so they are documented in different property tables. Each property table specifies which light types support those properties.
* [Light component](/docs/user-guide/components/reference/atom/light/): Contains several configurations that don't have a 1-1 relationship with the **Light type** property. Some property groups are available for more than one light type, so they are documented in different property tables. Each property table specifies which light types support those properties.

* [PhysX Collider component](/docs/user-guide/components/reference/physx/collider/): Contains several configurations, which depend on the **Shape** property. Each configuration affect what properties are available, so they are documented in different property tables separated into tabs.

Expand Down
Loading