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

Add some comments for Server re-org sample #155

Merged
merged 3 commits into from Oct 22, 2021
Merged

Add some comments for Server re-org sample #155

merged 3 commits into from Oct 22, 2021

Conversation

maria-robobug
Copy link
Contributor

No description provided.

Copy link
Collaborator

@osfameron osfameron left a comment

Choose a reason for hiding this comment

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

Briefly discussed with Maria - not sure about these comments:
Looks like they are replicating a lot of the information that could be factored in the Asciidoc?

I'm also not sure who the comment is for? Is this the right abstraction level for the typical developer? If we comment anything, would it be the shape of e.g. result or row? An example JSON output or similar.

Copy link
Contributor

@simon-dew simon-dew left a comment

Choose a reason for hiding this comment

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

Thanks @maria-robobug , this is great. I've just cut them down slightly to save space. As @osfameron says if further explanation is needed it can go in the AsciiDoc.

modules/hello-world/examples/n1ql-hello-world.js Outdated Show resolved Hide resolved
modules/hello-world/examples/n1ql-hello-world.js Outdated Show resolved Hide resolved
@simon-dew
Copy link
Contributor

simon-dew commented Oct 21, 2021

I'm also not sure who the comment is for?

I would say, a developer who has a good knowledge of the language, and maybe some prior knowledge of traditional SQL, but is new to Couchbase and needs to know what are the methods, objects, or functions offered by the SDK.

@maria-robobug
Copy link
Contributor Author

As @osfameron says if further explanation is needed it can go in the AsciiDoc.

Sounds good, just have some minor questions:

  • When we say this should go in the AsciiDoc are we referring to pages in the docs-server repo?
  • Or will we reference pages/partials from the docs-sdk-{insert-language-here} repos like we are doing with these code snippets?

maria-robobug and others added 2 commits October 21, 2021 14:54
Co-authored-by: Simon Dew <39966290+simon-dew@users.noreply.github.com>
Co-authored-by: Simon Dew <39966290+simon-dew@users.noreply.github.com>
@simon-dew
Copy link
Contributor

simon-dew commented Oct 21, 2021

When we say this should go in the AsciiDoc

I mean that these code snippets might be included anywhere. The including page should include the appropriate level of explanation. So in the docs server pages there might be more explanation; in the SDK pages there might be less.

@simon-dew
Copy link
Contributor

I'm updating couchbase/docs-server#2249 to include a one- or two-line explanation of these code snippets that is (hopefully) appropriate for the developer how-to guide. I'll add you as a reviewer when it's ready @maria-robobug

@maria-robobug maria-robobug merged commit 5222dd8 into couchbase:release/3.2 Oct 22, 2021
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.

None yet

3 participants