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

Adding HTTP scaling documentation #554

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

arschles
Copy link
Contributor

@arschles arschles commented Oct 14, 2021

This PR moves documentation about the HTTP Addon from the HTTP Addon repo. This PR is incomplete at the moment, but below is my idea for organization:

  • HTTP appears in the "Docs" dropdown on the nav bar, and directs to /docs/http
  • /docs/http contains a simple intro page as well as all of the documents currently in https://github.com/kedacore/http-add-on/tree/main/docs
  • /docs/2.4/concepts/ has "Scaling HTTP Applications" on the sidebar. That goes to an overview page, which contains links to /docs/http

Checklist

  • Commits are signed with Developer Certificate of Origin (DCO)
  • Add scaler intro doc to "concepts" dropdown
  • Move documentation from HTTP Addon wiki to subsection (e.g. /docs/http)
  • Version the documentation?

After this PR is merged, most documentation from the docs/ directory should be on the site, and removed from the http addon repo. Similarly, the wiki on the HTTP Addon repository should be removed in favor of this site.

Fixes #548

Signed-off-by: Aaron Schlesinger <aaron@ecomaz.net>
Signed-off-by: Aaron Schlesinger <aaron@ecomaz.net>
Signed-off-by: Aaron Schlesinger <aaron@ecomaz.net>
Signed-off-by: Aaron Schlesinger <aaron@ecomaz.net>
@arschles
Copy link
Contributor Author

@tomkerkhove can you let me know what you think about this initial layout?

@tomkerkhove
Copy link
Member

I am not seeing the HTTP page, is it possible that you forgot to add it?

@arschles
Copy link
Contributor Author

@tomkerkhove indeed it is. sorry about that - I'll check this out tomorrow and get it fixed up.

@tomkerkhove
Copy link
Member

No rush!

Signed-off-by: Aaron <aaron@ecomaz.net>
@arschles
Copy link
Contributor Author

@tomkerkhove I added a content/docs/2.4/http section so a page shows up under the /docs/2.4/http/ path, but I'm kind of confused what types of docs should go under there vs. the concept page at /docs/2.4/concepts/scaling-http/. Is there a best practice for that?

@arschles
Copy link
Contributor Author

@tomkerkhove there are 2 more TODOs on this PR, but I'm moving this out of draft now. I think it would be good to get a basic layout merged, and then I can add more content in follow-ups. If you agree, I'll pull the remaining TODOs out into issues. WDYT?

@arschles arschles marked this pull request as ready for review November 10, 2021 19:07
@arschles arschles mentioned this pull request Nov 18, 2021
2 tasks
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.

KEDA HTTP Addon documentation
2 participants