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

Client doc 294 #1464

Merged
merged 19 commits into from
Jan 30, 2025
Merged

Client doc 294 #1464

merged 19 commits into from
Jan 30, 2025

Conversation

amandalindsay
Copy link
Contributor

@amandalindsay amandalindsay commented Jan 9, 2025

See Docs ticket for details and SOW: https://hazelcast.atlassian.net/browse/DOC-294

In summary, this docs work involves:

  • moving some information from the Getting Started with Clients topic into a new Clients & API Overview topic
  • drafting a new Clients & API Overview topic that compares using clients versus APIs
  • tweaking the nav structure to create new Client and API sub-headings (note the question I have about moving memcache under APIs rather than clients)
  • updating the Java client topic with more information about embedded versus standalone Java client

This PR is now ready for review now that a decision has been made on how to refer to Clients & APIs (see docs ticket).

Note that the client features graphic on the main HZC website may change but, in the meantime, we will continue to link to it until a decision is made about what to do with it.

Copy link

netlify bot commented Jan 9, 2025

Deploy Preview for hardcore-allen-f5257d ready!

Name Link
🔨 Latest commit 56406a4
🔍 Latest deploy log https://app.netlify.com/sites/hardcore-allen-f5257d/deploys/679b636ff32d4e0008fc617c
😎 Deploy Preview https://deploy-preview-1464--hardcore-allen-f5257d.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@fawazghali fawazghali requested review from yuce and emreyigit January 9, 2025 13:16
Copy link
Contributor

@yuce yuce left a comment

Choose a reason for hiding this comment

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

Here are a few ideas...

docs/modules/clients/pages/client-overview.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/client-overview.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/client-overview.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/client-overview.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/client-overview.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/java.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/java.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/client-overview.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/client-overview.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/client-overview.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/client-overview.adoc Outdated Show resolved Hide resolved
Copy link
Contributor

@emreyigit emreyigit left a comment

Choose a reason for hiding this comment

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

I've went over on other comments and requested changes. Agreed @yuce and @ihsandemir. I think there is a misunderstanding about some concepts. I'm confused here what we are aiming. Instead of putting induvial comments, I prefer to clarify the cores first. I think having a meeting would be good idea to discuss the goal and cores.

@amandalindsay amandalindsay marked this pull request as ready for review January 20, 2025 13:49
@amandalindsay amandalindsay requested a review from a team as a code owner January 20, 2025 13:49
Copy link
Contributor

@oliverhowell oliverhowell left a comment

Choose a reason for hiding this comment

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

Some minor suggestions and quite a few questions where we might need @yuce perspective

docs/modules/ROOT/nav.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/hazelcast-clients.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/memcache.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/client-overview.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/client-overview.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/client-overview.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/java.adoc Show resolved Hide resolved
docs/modules/clients/pages/client-overview.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/client-overview.adoc Outdated Show resolved Hide resolved
docs/modules/clients/pages/hazelcast-clients.adoc Outdated Show resolved Hide resolved
Copy link
Contributor

@yuce yuce left a comment

Choose a reason for hiding this comment

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

Looks good!

@amandalindsay amandalindsay merged commit f59cac0 into main Jan 30, 2025
6 checks passed
@amandalindsay amandalindsay deleted the client-DOC-294 branch January 30, 2025 12:21
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.

6 participants