Expand my Community achievements bar.

July 31st AEM Gems Webinar: Elevate your AEM development to master the integration of private GitHub repositories within AEM Cloud Manager.
SOLVED

Using AEM for API Portal Documentation

Avatar

Level 1

Hello, my team is looking into leveraging AEM for an API developers portal. One of the current topics of discussion surrounds what to use for the documentation surrounding the APIs, our standards, etc.  They started considering the use of Confluence or BitBucket, but I wanted to see if AEM would handle the task as well so we aren't over-engineering things.

 

There was a list of needs given during our last meeting about this, but I will boil these down to a few in hopes that I can get an answer. I have tried searching online, but can't seem to come up with an answer....

 

  •         Search functionality
  •         Versioning
  •         Ability to roll back to previous versions
  •         Provides a role-based access functionality to allow permissions by Enterprise, Organization, Team or Individual
  •         Provides security for internal and external consumption
  •         Enables the ability to collaborate with groups outside our own and easily receive as well as solicit feedback
  •         Ability to collaborate on diagrams
  •         Ability to allow users to subscribe to certain aspects of standards
  •         Ability for users to receive notifications based on subscriptions
  •         Integration with Swagger
  •         Ability to convert to document types (i.e. pdf, html)
  •         Template capabilities

 

Thanks to anyone who offers their insights. I find it best to ask those who are elbows deep in it.

1 Accepted Solution

Avatar

Correct answer by
Level 2

Hi @JStumpf ,

 

Your team’s considerations for an API developers portal are crucial, and it's great that you're evaluating various tools to avoid over-engineering. Given the needs you've outlined, Adobe Workfront could be a compelling solution as it integrates well with Adobe Experience Manager (AEM) and offers several features that might meet your requirements.

The following points may help you decide or at least give you some idea:-

1. Search Functionality:

  • Workfront provides robust search capabilities that can help your team quickly find documentation and other resources.

2. Versioning and Rollback:

  • Workfront supports versioning of documents and tasks, allowing you to track changes over time and revert to previous versions if necessary.

3. Role-Based Access:

  • It includes comprehensive role-based access controls, enabling you to set permissions at various levels.

4. Security:

  • Workfront ensures secure access for both internal and external stakeholders, which aligns with your need for security in documentation consumption.

5. Collaboration and Feedback:

  • The platform is designed for collaboration, allowing teams to work together on documents, share feedback, and manage tasks efficiently.

6. Diagram Collaboration:

  • You can use integrated tools within Workfront or integrate with other diagram tools to collaborate on visual content.

7. Subscription and Notifications:

  • Users can subscribe to updates and receive notifications about changes or new content related to their interests.

8. Integration with Swagger:

  • While Workfront doesn’t natively integrate with Swagger, AEM does support integration with Swagger for API documentation. You can manage the API lifecycle in AEM and use Workfront for the project and task management aspects.

9. Document Conversion:

  • Workfront allows you to convert documents into various formats such as PDF and HTML, ensuring your content is versatile.

10. Templates:

  • It provides template capabilities that can standardize documentation and workflows across your projects.

The following links can help you understand better.
https://business.adobe.com/in/products/workfront/main.html
https://business.adobe.com/in/products/workfront/services-support.html
https://business.adobe.com/products/workfront/aem-integration.html

Hope you got some help!
Cheers!

View solution in original post

1 Reply

Avatar

Correct answer by
Level 2

Hi @JStumpf ,

 

Your team’s considerations for an API developers portal are crucial, and it's great that you're evaluating various tools to avoid over-engineering. Given the needs you've outlined, Adobe Workfront could be a compelling solution as it integrates well with Adobe Experience Manager (AEM) and offers several features that might meet your requirements.

The following points may help you decide or at least give you some idea:-

1. Search Functionality:

  • Workfront provides robust search capabilities that can help your team quickly find documentation and other resources.

2. Versioning and Rollback:

  • Workfront supports versioning of documents and tasks, allowing you to track changes over time and revert to previous versions if necessary.

3. Role-Based Access:

  • It includes comprehensive role-based access controls, enabling you to set permissions at various levels.

4. Security:

  • Workfront ensures secure access for both internal and external stakeholders, which aligns with your need for security in documentation consumption.

5. Collaboration and Feedback:

  • The platform is designed for collaboration, allowing teams to work together on documents, share feedback, and manage tasks efficiently.

6. Diagram Collaboration:

  • You can use integrated tools within Workfront or integrate with other diagram tools to collaborate on visual content.

7. Subscription and Notifications:

  • Users can subscribe to updates and receive notifications about changes or new content related to their interests.

8. Integration with Swagger:

  • While Workfront doesn’t natively integrate with Swagger, AEM does support integration with Swagger for API documentation. You can manage the API lifecycle in AEM and use Workfront for the project and task management aspects.

9. Document Conversion:

  • Workfront allows you to convert documents into various formats such as PDF and HTML, ensuring your content is versatile.

10. Templates:

  • It provides template capabilities that can standardize documentation and workflows across your projects.

The following links can help you understand better.
https://business.adobe.com/in/products/workfront/main.html
https://business.adobe.com/in/products/workfront/services-support.html
https://business.adobe.com/products/workfront/aem-integration.html

Hope you got some help!
Cheers!