Proposed SIG-Docs meeting agenda for 2022-06-14

[FiniteStateGit]

Meeting Details

• Date/Time: June 14, 2022 @ 1800 UTC / 11:00am PT1800 UTC / 11:00am PT
• Location: Discord SIG-Docs Voice Room
• Moderator: @FiniteStateGit
• Note Taker: @FiniteStateGit

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

SIG Updates

Refer to the following links for the latest google crawler coverage reports:
#42 (comment)

Open action items

• We need somebody to start working on RFCs for automated submission checks, so that we can avoid filing regular broken link issues.
• It is recommend we remove the https://docs.o3de.org/ subdomain and just use https://o3de.org/docs - also it may be that the way we are using/redirecting our www. subdomain is causing google to treat it differently - might we worth examining the DNS record to check for anomalies.
  • Double check source for any links to docs.o3de.org.
• Announce sig-docs-elections 6/28.
• Website refresh: Nicole Huesman[LF] will approach sig-docs and sig-ui-ux for comment on the proposal this week.

Previous meeting's open action items:
#41

Open RFC's

• RFC [process]: SIG docs-community assignment during triage #43
• Proposed SIG-Docs-Community Feature Grid #40

Agenda Items

From @micronAMZN :
https://image-compare-viewer.netlify.app/
Sig needs a process for accepting 3P packages to Netlify build.

From @aFinchy:
https://docs.google.com/document/d/1Uuz0mvEOMcXBAzcJpop7EqFGzbU2nhXK52wG_c_ls08/edit
Requests sig-docs-community prepare our contribution similar to the example.

[FiniteStateGit]

Message from @OBWANDO:

Hi O3DE SIGs!

We’re building an O3DE project roadmap through early 2023, which will help inform our marketing roadmap & activities. We’d appreciate your help in surfacing your SIG roadmaps (e.g. key features/capabilities you’re working on & timing) so we can build them into this roadmap. Would love to hear from you by next Friday, June 3, if possible. Many thanks in advance for your collaboration!

If a roadmap template would help to collect this information, please let me know & I’ll create one.

[FiniteStateGit]

o3de/o3de.org#1653 (comment)

[FiniteStateGit]

Feedback from developer:

Please add clarity to style guide re: tool names, specifically the lesser known tools and how to refer to these tools in general. O3DE tools.

o3de/o3de.org#1687

[FiniteStateGit]

Could we get an update from @AMZN-alexpete on Google site indexing?

[AMZN-alexpete]

Here's the latest coverage report for https://o3de.org/docs

For the 600 results excluded because of redirects/duplicates it's because we have an https://docs.o3de.org subdomain that duplicates https://o3de.org/docs, but also https://www.o3de.org/docs somehow for example:

The 118 excluded as duplicates without canonical are largely the API pages.

I recommend we remove the https://docs.o3de.org subdomain and just use https://o3de.org/docs - also it may be that the way we are using/redirecting our www. subdomain is causing google to treat it differently - might we worth examining the DNS record to check for anomalies.

[FiniteStateGit]

@AMZN-alexpete

Thanks for doing this! It looks like we needed more time for the pages that were excluded earlier in the year to be indexed. I will capture removing the https://docs.o3de.org/ subdomain as a Sig task.

[FiniteStateGit]

From @micronAMZN :

https://image-compare-viewer.netlify.app/

Sig needs a process for accepting 3P packages to Netlify build.

[FiniteStateGit]

From @aFinchy:

https://docs.google.com/document/d/1Uuz0mvEOMcXBAzcJpop7EqFGzbU2nhXK52wG_c_ls08/edit

Requests sig-docs-community prepare our contribution similar to the example.

[FiniteStateGit]

Meeting notes are inline with this agenda.

[micronAMZN]

Would like to discuss removing the known-issue shortcode and providing strict guidance around known issues. Devs often want to put known issues right in the feature docs pages and tutorials. These callouts will persist long after the issues are resolved and if we have lot of these in the docs, they can erode user confidence in both O3DE and the docs.

I suggest we only allow known issues to be called out in the Known Issues topic of Release Notes.