Proposed SIG-Docs meeting agenda for 2023-03-07

chanmosq commented 1 year ago

Meeting Details

Date/Time: March 7, 2023, Year @ 2023 10:30am PT
Location: Discord SIG-Docs Voice Room
Moderator: chanmosq
Note Taker: chanmosq

The SIG-Docs Meetings contains the history past calls, including a link to the agenda, recording, notes, and resources.

SIG Updates

What happened since the last meeting?

~~[Change in process] https://github.com/o3de/o3de.org/pull/2245 The change partially automates syncing main to development.~~
- Reverted this change due to problems with unwanted commits going into dev
Added new label kind/dev-documentation. This is for documentation that belong in the Engine Developer Guide
Reindexing o3de.org site to fix search engine results. A number of issues flagged that users were being led to docs.o3de.org, which is a deprecated URL now.

Open action items

Newly resolved items

https://github.com/o3de/sig-docs-community/issues/102 - Discussed solution at last sig-docs-community meeting. Came to an agreement with Release SIG. A new ticket was opened in o3de.org with the solution proposed.

Initial Agenda

The pre-approved agenda for this meeting is as follows:

SIG Updates - Chanelle - 10m
- Description of the item
https://github.com/o3de/sig-docs-community/issues/103 - Willow - 5m
May Release Process - Willow/Chanelle - 25m
- https://github.com/o3de/sig-release/issues/133
- https://github.com/o3de/sig-docs-community/issues/105
- Important dates
- Mar 15, 10AM PT - Create docs stabilization branch
- Mar 15 to Apr 5 - Stabilization period
- Apr 12 - Code Freeze
- May 3 - Release day! O3DE Release 23.05.0
- Tasks - Looking for owners to assist with tasks during release period
- Create docs stabilization branch (@willihay)
- Author release notes
- C++ API Reference Generation (After stabilization period)
- Create new Docs versioning branch, update docs version selector (@willihay )
- Finalize feature grid
- Update O3DE version in website (@willihay )

Suggesting and voting on agenda items

Our community is welcome to suggest and vote on agenda items. If you suggest an item you need to have a designated presenter (normally the issue filer), but any community member can vote and isn't required to attend meetings or even participate in further discussion. If you think something is a good idea to discuss for the O3DE community, please upvote!

:+1: reactions to proposed agenda items are counted as YEA votes for taking up discussion, and :-1: as NAY. Votes on items don't determine the final agenda, but do influence it and are strongly taken into consideration as a representation of what the O3DE community wants to see from the project.

Agenda item format

If you leave a comment on this issue to propose an agenda item, please use the following format:

**Topic**: The topic you'll be presenting on
**Presenter**: Who will present (may be a team name or TBD)
**Length of time**: Estimate the amount of time you believe discussion will take. This should not be more than 15 minutes without SIG approval.

Include a description of your topic. Make sure to link to any supplementary materials such as RFCs, forum discussions, issues, etc.

Remember to add the :+1: and :-1: reactions manually, so they appear and are obvious to voters!

willihay commented 1 year ago

Agenda item: Nomination for me as website reviewer: https://github.com/o3de/sig-docs-community/issues/103

willihay commented 1 year ago

Agenda item: May release process

We will need a docs stabilization branch on March 15th.

chanmosq commented 1 year ago

Agenda item: Changing to one-direction gitflow for o3de.org

What this change looks like: We want to introduce a change such that changes are primarily done in the development branch. The one-direction flow means that most changes in development get merged into main, but main never gets merged back to development. Currently, the main and development branches are used regularly - main for updates to existing docs, and development for docs about features in development.

What will the transition look like

chanmosq commented 1 year ago

Some more information regarding May release: https://github.com/o3de/sig-release/issues/133

chanmosq commented 1 year ago

Meeting notes

Other SIG Updates

Updates to CODEOWNER files
- https://github.com/o3de/o3de.org/pull/2252
- Upcoming update as we transition to primarily working in the development branch

Election https://github.com/o3de/sig-docs-community/issues/107

Election announcement (@willihay)
Update the sig-docs-community template in this PR https://github.com/o3de/community/pull/171/files Agenda (@willihay)

Approved https://github.com/o3de/sig-docs-community/issues/103

[ ] Add willow to group (@chanmosq )

Changing o3de.org gitflow process

SIG members agree that primarily working out of development is the way to go. They also raised some specific cases to consider, like patch fixes (cherry-pick forward commits from dev to main), issues when transitioning (noted below)
Transitioning o3de.org gitflow process
- [ ] Start communicating future PRs so they're pointing at development (@chanmosq)
- [ ] Update the contributor guide (@micronAMZN )
- [ ] Syncing main to development (@FiniteStateGit, sync PR to be merged before we create stabilization branch Mar 15)
- Maintenance of existing PRs that are pointed main: Leave them pointed to main (might cause more problems to redirect them to development). Then, cherry-pick the commits to development.
- [ ] Verify commits made to main or dev are also in both main or dev. A commit may have slipped through the cracks.
- Stabilization period Commits should continue to go to development branch, then cherry-picked back to development. This approach seems the safest.

Engine Developer Guide going to main

SIG members agree that engine developer guide should be maintained in the main
Because O3DE's core feature is that you can develop the engine, docs should be readily accessible and available

o3de / sig-docs-community