O3DE website Documentation #182
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
chanmosq
requested changes
Mar 1, 2023
markdown/o3de-website/README.md
Outdated
|
|
||
| This guide provides guidance on the process of publishing a blog on the O3DE website. This document covers selecting a topic, identifying an author, designing the blog, and publishing on site. Additionally, it offers troubleshooting tips in case any issues arise during the blog's publication. | ||
|
|
||
| To ensure a smooth publishing process, it is crucial to keep all relevant parties informed about the scheduled release date and any updates related to it. This includes the author of the blog and other stakeholders, such as the Marketing Committee. Clear communication with all parties involved can prevent any confusion or delays in the publishing process. |
There was a problem hiding this comment.
Suggest adding a tip on how to communicate with folks, such as what channel to send a message to, and a link to the Discord. See example of wording in Tools UI landing page.
Co-authored-by: chanmosq <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Co-authored-by: chanmosq <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Co-authored-by: chanmosq <[email protected]> Signed-off-by: Amy Finch <[email protected]>
4 tasks
chanmosq
requested changes
Mar 1, 2023
There was a problem hiding this comment.
Great job on the Blog Process doc! I've left a some suggestions.
I also have some comments about the overall info architecture:
I'm not sure if there's a reason for the structure of the documentation in the markdown/ folder, however I found it odd that they are all in separate folder's READMEs. The user would have to click into each folder to get to the document and may also have trouble finding the doc they need. As an alternative solution, you might consider flattening all the files (no subfolders) in the markdown/ folder, and renaming them accordingly. For example, I think o3de-website/README.md should be renamed to blog-processing.md. That would help us navigate the folder better and find the file we're looking for.
markdown/o3de-website/README.md
Outdated
Comment on lines
50
to
51
| 3. **Plan date for blog arrival** | ||
| Once you've found a blog writer, you'll need to discuss with them their availability to complete the blog. Avoid pressuring them, especially if they have a busy schedule. It's advisable to ask for a deadline and add a few extra days to allow for unexpected delays. |
There was a problem hiding this comment.
Good advice! Discussing timelines for blogs and working with others' schedules can be tricky.
markdown/o3de-website/README.md
Outdated
Comment on lines
65
to
70
| 4. **PR Stage Timeline** | ||
| During the PR stage, the blog goes through a review process by multiple parties to ensure that it follows the correct technical format, proper referencing, and appropriate linking. This is a standard practice to catch any missing or incorrect information and make necessary corrections. | ||
|
|
||
| To merge the blog into the main website, at least two individuals must approve the PR. | ||
|
|
||
| It is recommended to allow for 1-2 weeks (7 to 14 days) for the blog to be merged from the time of submission into PR. Rushing the process may lead to errors or missing the intended publication date. |
There was a problem hiding this comment.
I suggest moving this section between "2. Publish date finalized" and "3. Social Media"
You should also consider including links (either here or another fitting place) to guides that can assist folks with the PR process. It requires a GitHub account and typically Git set up on your local machine. Or if you do this another way, it would help to know how to set that up.
Here are links from the Contributing Guide that can help with that:
- Get Started Contributing to Docs: You’ll learn how to set up your writing environment and about the processes you need to get your documentation from text editor to the official O3DE documentation.
- The Move on to pull requests section and Documentation process overview section of the Overview of the Docs Contribution Process: You'll understand the pull request process and what to expect from reviewers of the O3DE community.
Co-authored-by: chanmosq <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Agreed Co-authored-by: chanmosq <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Co-authored-by: chanmosq <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Co-authored-by: chanmosq <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Co-authored-by: chanmosq <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Co-authored-by: chanmosq <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Co-authored-by: chanmosq <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]>
DCO Remediation Commit for aFinchy [email protected] I, aFinchy [email protected], hereby add my Signed-off-by to this commit: b59e5fc Signed-off-by: aFinchy [email protected]
DCO Remediation Commit for Amy Finch <[email protected]> I, Amy Finch <[email protected]>, hereby add my Signed-off-by to this commit: b59e5fc, 9488636 Signed-off-by: Amy Finch <[email protected]>
DCO Remediation Commit for Amy Finch <[email protected]> I, Amy Finch <[email protected]>, hereby add my Signed-off-by to this commit: b59e5fc, 9488636, be2d9ae Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
DCO Remediation Commit for Amy Finch <[email protected]> I, Amy Finch <[email protected]>, hereby add my Signed-off-by to this commit: b59e5fc, 9488636, be2d9ae, 526fb8a Signed-off-by: Amy Finch <[email protected]> Signed-off-by: Amy Finch <[email protected]>
Signed-off-by: Amy Finch <[email protected]>
|
Closed going to make a PR per Document |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Created
GitHub markdown
This manual is produced to assist members who are interested in establishing GitHub repositories or maintaining current ones and seeking to explore their true capabilities, along with step-by-step instructions and illustrative examples.
GitHub Markdown
Blog Process Guides
These resources are available to offer support and direction on optimal approaches for constructing and sustaining blogs for the O3DE Website. This document will be regularly revised to reflect any modifications made over time.
Blog Process Guide
O3DE Blog Cheatsheet
Templates and Examples
O3DE Website Maintenance
These resources offer support in generating code, banners, and color schemes for the website. Additionally, they provide instructions on updating images, adding new foundation members, and revising different sections of the o3de website.
O3DE Website Updates