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

Use Cases refactoring #73

Merged
merged 4 commits into from
May 2, 2024
Merged

Use Cases refactoring #73

merged 4 commits into from
May 2, 2024

Conversation

undavide
Copy link
Collaborator

Description

Over time, the Use Cases page has become too large; it's been split into a sub-menu, grouping cases by subject and moving them to individual pages. This not only rationalises and makes the content more accessible but also allows adding additional content in the future—à la cookbook—to cover new APIs with mixed material (narrative/snippets) that is not too long (tutorials) and not too short (just code).

The submenus ATM are:

  • Content Management
  • Authentication and Authorization
  • Client-side Data
  • User Interaction
  • Environment Settings
  • Monetization Flows
  • Content Authoring and Metadata

Old links pointing to the single use_cases.md page have been chased all over the doc website and redirected to the new pages. I've fixed some internal links that were expressed as https:// URLs. The original content has also been touched, lightly, for clarity.

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Davide Barranca added 2 commits April 19, 2024 16:34
Fix loads of links due to the change in the use cases structure
Copy link
Collaborator

@hollyschinsky hollyschinsky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@hollyschinsky hollyschinsky merged commit db055d5 into main May 2, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants