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: improvements to REST API tutorial #198

Merged
merged 4 commits into from
Nov 13, 2023

Conversation

agilgur5
Copy link
Contributor

@agilgur5 agilgur5 commented Nov 11, 2023

Summary

Several documentation improvements to the REST API tutorial

Basically the equivalent of #196 but for the REST API tutorial instead

Details

  • additions:

    • add link to REST API reference and Python API reference
  • stylistic improvements:

    • simplifications:
      • "For demonstration or exploration alone" -> "For demonstration purposes"
      • "make sure the username and password provided are identical" -> "make the username and password identical"
      • "as per your configuration" -> "based on your configuration"
      • "As per the demo configuration" -> "For the demo"
      • see also k8s style guide on simple and direct language (which I use and reference often for docs -- it's a pretty great style guide!)
    • consistency:
      • "Large Language Model" -> "LLM"
        • almost everywhere else in the docs, including further up in this same doc, "LLM" is used as short-hand
          • "Large Language Model" can be explained in the first, intro doc, and then short-hand used everywhere after
      • "you can start" -> "you can now start"
        • "you can now" is used in other parts of this doc and is indicative of a sequence of steps
    • code style:
  • fix various spelling and grammar errors and typos:

    • "workflows starts" -> "workflows start"
    • "can select the components" -> "can select components"
      • the components are already described immediately after
    • "you terminal" -> "your terminal"
    • "a HTTP client" -> "an HTTP client"
    • "authentication into your user session" -> "authenticating your user session"
      • remove extra commas here as well
    • "you set" -> "set"
    • "And, use" -> "And use"
    • "(LLM)s" -> "(LLMs)"

- additions:
  - add link to REST API reference and Python API reference

- stylistic improvements:
  - simplifications:
    - "For demonstration or exploration alone" -> "For demonstration purposes"
    - "make sure the username and password provided are identical" -> "make the username and password identical"
    - "as per your configuration" -> "based on your configuration"
    - "As per the demo configuration" -> "For the demo"
    - see also [k8s style guide on simple and direct language](https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language) (which I use and reference often for docs -- it's a pretty great style guide!)
  - consistency:
    - "Large Language Model" -> "LLM"
      - almost everywhere else in the docs, including further up in this same doc, "LLM" is used as short-hand
        - "Large Language Model" can be explained in the first, intro doc, and then short-hand used everywhere after
    - "you can start" -> "you can now start"
      - "you can now" is used in other parts of this doc and is indicative of a sequence of steps
  - code style:
    - remove new line after `!!! tip`
      - otherwise most markdown editors will recognize the block as a code block due to the 4 space indentation

- fix various spelling and grammar errors and typos:
  - "workflows starts" -> "workflows start"
  - "can select the components" -> "can select components"
    - the components are already described immediately after
  - "you terminal" -> "your terminal"
  - "a HTTP client" -> "an HTTP client"
  - "authentication into your user session" -> "authenticating your user session"
    - remove extra commas here as well
  - "you set" -> "set"
  - "And, use" -> "And use"
  - "(LLM)s" -> "(LLMs)"

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
pmeier
pmeier previously requested changes Nov 11, 2023
Copy link
Member

@pmeier pmeier left a comment

Choose a reason for hiding this comment

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

See #197 (review) for my inline comment. I'll let @pavithraes handle the rest.

docs/tutorials/rest-api.md Show resolved Hide resolved
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 requested a review from pmeier November 12, 2023 19:49
@pmeier pmeier requested review from pavithraes and removed request for pmeier November 13, 2023 10:22
@pmeier pmeier dismissed their stale review November 13, 2023 10:22

Rednering issue fixed

Copy link
Member

@pavithraes pavithraes left a comment

Choose a reason for hiding this comment

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

Thanks, @agilgur5! Looks great, and again all suggestions are related to formatting (line length), we can merge after! 🌻

docs/tutorials/rest-api.md Outdated Show resolved Hide resolved
docs/tutorials/rest-api.md Outdated Show resolved Hide resolved
docs/tutorials/rest-api.md Outdated Show resolved Hide resolved
docs/tutorials/rest-api.md Outdated Show resolved Hide resolved
docs/tutorials/rest-api.md Outdated Show resolved Hide resolved
@pavithraes pavithraes added area: documentation 📖 Improvements or additions to documentation type: maintenance 🛠️ Day-to-day maintenance tasks pr-status: changes requested 🧱 labels Nov 13, 2023
Copy link
Member

@pmeier pmeier left a comment

Choose a reason for hiding this comment

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

Thanks @agilgur5 for the PR and @pavithraes for the review!

@pmeier pmeier merged commit 4962665 into Quansight:main Nov 13, 2023
3 of 4 checks passed
@agilgur5 agilgur5 deleted the docs-edit-rest-tutorial branch November 13, 2023 23:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📖 Improvements or additions to documentation pr-status: changes requested 🧱 type: maintenance 🛠️ Day-to-day maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants