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.

Sign up for GitHub

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

Jump to bottom

Website update #381

Closed
lornajane opened this issue Apr 1, 2022 · 0 comments
Closed

Website update #381

lornajane opened this issue Apr 1, 2022 · 0 comments
Labels
doc Improvements to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@lornajane
Copy link
Contributor

Karapace has a web presence at https://karapace.io which is good but minimal. The plan (comments welcome) is to do the following:

  • move the website into this repository so that it's easier to keep both in sync
  • consider if the tool/build of the site needs updating, and if so, do that
  • move some of the usage examples and installation instructions from the README into website documentation, under "Installation" and "Examples" pages or sections
  • revisit all the wording on the existing site, and expand the "Home" and "About" pages

See also: #181 , and include API documentation on the site when we have it.

(should this be an epic, it's pretty extensive?)
@lornajane lornajane mentioned this issue Apr 1, 2022
Closed
@lornajane lornajane added enhancement New feature or request help wanted Extra attention is needed doc Improvements to documentation labels Apr 1, 2022
@lornajane lornajane self-assigned this Apr 27, 2022
@lornajane lornajane mentioned this issue Apr 27, 2022
Closed
@lornajane lornajane removed their assignment Mar 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Improvements to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Replace Karapace's website with a landing page and some docs Aiven-Open/karapace
1 participant
@lornajane