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

doc: re-design Information Architecture of AsyncAPI Docs #350

Closed
alequetzalli opened this issue Sep 8, 2021 · 3 comments · Fixed by #601
Closed

doc: re-design Information Architecture of AsyncAPI Docs #350

alequetzalli opened this issue Sep 8, 2021 · 3 comments · Fixed by #601

Comments

@alequetzalli
Copy link
Member

alequetzalli commented Sep 8, 2021

Reason/Context

We need this improvement because we are lacking:

  • Concepts content bucket, expanding on AsyncAPI concepts/terms and how they work
  • Better classification of "getting started" vs advanced cases
  • move the misc Tooling page and/or decide what else may be needed to add for community
  • improved User Flows: where do our readers really need to go next?

The new content buckets for our Docs will be the following:

  • Concepts
  • Tutorials
  • How-To Guides
  • Tools
  • Reference

These new content buckets introduce a different URL structure than what is currently in place. Handling all redirects needed via issue #459.

Description

  • Changes introduced will mean re-structuring current content
  • Changes introduced will mean adding a whole new bucket section and reworking the current content buckets
  • Changes introduced will likely mean links changing, so thorough review for final links should be done to ensure NO 404s occur
  • This will build on the previously opened issue for Concepts by @derberg: Create a document that describes clearly core concepts of AsyncAPI #91
@github-actions
Copy link

github-actions bot commented Sep 8, 2021

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.

Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@derberg
Copy link
Member

derberg commented Sep 9, 2021

Huge fan of redesigning the info architecture!

Changes introduced will likely mean links changing, so thorough review for final links should be done to ensure NO 404s occur

we will just need to set proper redirects here and all will be good

move the misc Tooling page and/or decide what else may be needed to add for community

yeah, this one. Over time I have to admit I don't like we have only few tools under main nav Tools and then the rest (AsyncAPI + community tools) mixed under docs view (in nav Community -> Tools). Imho we should merge these in a single view, away from docs. So we have Tools where we still have these core tools featured, but there should also be item All Tools Landscape that says something like A list of all the tools maintained by AsyncAPI Initiative or outside it. It would take readers to a new view, where they see all the tools mentioned now under Community -> Tools (but long term this website should be automated so our bot adds AsyncAPI projects there - as no many are missing and no one have time to add them)

@github-actions
Copy link

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done 🚀
AsyncAPI Docs Board
  
Done 🚀
Development

Successfully merging a pull request may close this issue.

2 participants