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

docs: refactor resources, add gpu, kong #5027

Merged
merged 8 commits into from
Aug 8, 2022
Merged

docs: refactor resources, add gpu, kong #5027

merged 8 commits into from
Aug 8, 2022

Conversation

tarrantro
Copy link
Contributor

@tarrantro tarrantro commented Jul 22, 2022

Goals:

  • Add document for JCloud gateway

  • Add document for GPU support

@github-actions github-actions bot added size/S area/docs This issue/PR affects the docs labels Jul 22, 2022
@JoanFM JoanFM changed the title docs: add jcloud gatewaty document docs: add jcloud gateway document Jul 22, 2022
Copy link
Member

@JoanFM JoanFM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@deepankarm @JohannesMessner ,

can you please review the wording?

Copy link
Member

@JoanFM JoanFM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also make sure to clarify the difference between core Gateway and this Kong Gateway

Copy link
Contributor

@JohannesMessner JohannesMessner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a few things that are not quite clear to me (probably because I don't know much about these technologies, but I imagine some of our users might be in a similar position):

  • The two supported Gateways are ALB and Kong, right? Then I wouldn't put theme in a note note-box, rather put them in a listing or just as separate sub-sections, depending on how much additional details are presented for each of them
  • I don't know what layer 7 and layer 4 load balancing mean, what are their implications for me as a user?
  • Apart from that, certs seem to be the main difference between the two. When should I choose what on that dimension?
  • It is suggested to use Kong, but why? What are the advantages I get as a user?

Again, some of these questions might be super trivial, but it would be cool if you could provide a bit more context around them!

docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
Copy link
Member

@JoanFM JoanFM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to explain that this has nothing to do with our Gateway inside Jina

Copy link
Contributor

@JohannesMessner JohannesMessner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The added explanation about level 7 and level 4 is great for me!

I still have a few suggestions (because I am picky) and also please don't use backticks for highlighting, we decided to only use them to render short code snippets (classes/methods/yaml optons etc.).

docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
@deepankarm
Copy link
Contributor

@tarrantro I'll work on editing a few sections in this PR. Making it a draft now.

@deepankarm deepankarm marked this pull request as draft July 27, 2022 07:38
JoanFM
JoanFM previously requested changes Jul 28, 2022
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
@tarrantro
Copy link
Contributor Author

add GPU document as well

@tarrantro tarrantro changed the title docs: add jcloud gateway document docs: add jcloud documents for Kong gateway and GPU Aug 1, 2022
@delgermurun
Copy link
Contributor

Don't forget to remove "JCloud doesn’t support GPUs yet." from https://docs.jina.ai/fundamentals/jcloud/faq/ 😄

Copy link
Contributor

@JohannesMessner JohannesMessner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the description of GPU support. Just two points:

  • Is a provisioned GPU usable for the entire Flow? Or can it be assigned on a per-Executor basis? This is not so clear to me
  • If dedicated GPU is the default way of doing it, that should probably come before shared GPU

docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
docs/fundamentals/jcloud/advanced.md Outdated Show resolved Hide resolved
@deepankarm deepankarm changed the title docs: add jcloud documents for Kong gateway and GPU docs: refactor resources, add gpu, kong Aug 7, 2022
@deepankarm deepankarm force-pushed the docs-add-kong branch 8 times, most recently from 3dbc7ed to d5f3348 Compare August 7, 2022 12:58
@github-actions
Copy link

github-actions bot commented Aug 7, 2022

📝 Docs are deployed on https://docs-add-kong--jina-docs.netlify.app 🎉

@deepankarm deepankarm marked this pull request as ready for review August 8, 2022 02:33
@deepankarm deepankarm dismissed stale reviews from JohannesMessner and JoanFM August 8, 2022 02:34

Addressed

@deepankarm deepankarm merged commit 8c6321a into master Aug 8, 2022
@deepankarm deepankarm deleted the docs-add-kong branch August 8, 2022 02:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs This issue/PR affects the docs size/M size/S
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants