Skip to content

Documentation shift and merge#382

Merged
pru55e11 merged 131 commits intomainfrom
prussell-merge
Apr 30, 2025
Merged

Documentation shift and merge#382
pru55e11 merged 131 commits intomainfrom
prussell-merge

Conversation

@pru55e11
Copy link
Copy Markdown
Collaborator

We are undertaking a comprehensive reorganization of our runtime and app builder documentation. This involves:

Removing Redundancies: Eliminating duplicate content to streamline information.
Grouping Like Content: Organizing related topics together for easier navigation.
Nested: Moving Runtime as a subset of App Builder docs

These changes aim to enhance the user experience by making it simpler for customers to find the information they need.

Patrick Mulvanny / Reddbug added 30 commits November 5, 2024 16:31
Consolidated App Builder and I/O Runtime FAQs, reorganized them under a two-level hierarchy, and copy-edited.
Copy-edits only to App Builder Security pages; three content issues identified in 11/6 status report email.
Resolved three issues on the Security Guide page per Patrick Russell's input.
Added new business-case page; edited overview pages, consolidating App Builder and I/O Runtime content. Highlighted relative links are dummies until the tree structure stabilizes.
Copy-edit all App Builder "Getting Started" pages, with some changes to filenames. Many links are broken or absent; most have been highlighted.
Consolidated I/O Runtime pages into App Builder repository; renamed several folders and files.
Copy-edited Getting Started with Adobe I/O Runtime and I/O Runtime Quick Start Guide.
Reorganized file structure, renamed files, and completed edits to I/O Runtime "Get Started" section. Links have been updated but not tested. Empty or replaced files renamed "null."
Completed merger, restructuring, cleanup, and copy-editing of Intro/Overview section, Get Started I/O Runtime tutorial, and Get Started App Builder tutorial.
Restructured Guides file tree; created new Guides landing page and index; and copy-edited application-logging, configuration, and architecture-overview threads and development file.
…tion, and telemetry Guides

Copy and navigation edits to architecture, deployment, development, distribution, and telemetry Guide sections and pages.
Edits and filename changes to logging, configuration, deployment, distribution, and experience cloud integration pages.
…Guides

Finished copy-edits to App Builder Guides, except for:
1) items to be moved from other sections (Debugging, Troubleshooting)
2) external links (Reference Documentation)
3) technical copy that won't need to move or require much editing (Code Labs)
Added Runtime Guides to a new folder under App Builder and started copy-edits.
Edits completed to Runtime Guides. Reference documentation, Tools, and Resources remain.
Edits to Runtime guides and App Builder Code Lab reference pages.
Copy-edits finished for all pages; some broken and obsolete links remain for React Spectrum resources.
…r Developer Forum.

App Builder Developer Forum links return 404; search doesn't find a substitute.
Reviewed and fixed all internal and external links for App Builder Resource pages (Code Labs), with exceptions:
1) Asset Compute Worker Photoshop API/Requirements - Can't find free Photoshop API trial.
2) Spectrum Intro Lessons 2 and 3 - bad React links identified with "404" in text.
3) To-Do Application - relies on old React documents; probably OK for Code Lab.
4) Internal links to anchor tags work at the page level, but will need to be verified within pages.
Checked and updated/fixed all internal and external links in Runtime Guides, including all Reference Docs and Tools, plus Contribution Guide and Guide Index.
File wsk_use has been deleted.
File api_ref table formatting is broken.
Internal links to anchor tags need to be checked
…loud integrations

No issues, but internal links to anchor tags will need to be checked.
App Builder Security, Development, Distribution, and Optimization pages.
Logging, CI/CD, and Deployment sections; note redirects for Events section.
@pru55e11 pru55e11 added documentation Improvements or additions to documentation DO_NOT_MERGE labels Apr 21, 2025
@pru55e11 pru55e11 merged commit 2cd07c0 into main Apr 30, 2025
7 checks passed
@purplecabbage
Copy link
Copy Markdown
Contributor

huge accomplishment here!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants