Skip to content

Documentation: Improve landing page & split usage page #448

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

Closed
fhennig opened this issue May 17, 2023 · 0 comments · Fixed by #470
Closed

Documentation: Improve landing page & split usage page #448

fhennig opened this issue May 17, 2023 · 0 comments · Fixed by #470

Comments

@fhennig
Copy link
Contributor

fhennig commented May 17, 2023

part of: stackabletech/documentation#408

example of an improved landing page: https://docs.stackable.tech/home/stable/druid/index.html

The new landing page should feature:

  • meta tags and a meta description
  • an introduction of the tool
  • a section about getting started
  • a description and diagram of the resources it creates
  • a description of its dependencies or other operators that interact with it
  • a link to demos that use the operator
  • the versions (as already present)

To split the usage guide, turn it into a section like here. For pages that exist in Druid/other operators, try to keep the same ordering as in those operators.

@fhennig fhennig moved this to Development: Waiting for Review in Stackable Engineering Aug 24, 2023
@fhennig fhennig moved this from Development: Waiting for Review to Development: Done in Stackable Engineering Aug 29, 2023
@lfrancke lfrancke moved this from Development: Done to Done in Stackable Engineering Aug 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant