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: Clarify meaning of url param, update in-repo CLI docs #814

Merged
merged 2 commits into from
Sep 18, 2022

Conversation

orpheuslummis
Copy link
Contributor

@orpheuslummis orpheuslummis commented Sep 16, 2022

Relevant issue(s)

Resolves #788

Description

Simply changes the parameter's documentation.

Additionally, regen in-repo docs.

Tasks

  • I made sure the code is well commented, particularly hard-to-understand areas.
  • I made sure the repository-held documentation is changed accordingly.
  • I made sure the pull request title adheres to the conventional commit style (the subset used in the project can be found in tools/configs/chglog/config.yml).
  • I made sure to discuss its limitations such as threats to validity, vulnerability to mistake and misuse, robustness to invalidation of assumptions, resource requirements, ...

How has this been tested?

Manual testing ...

Specify the platform(s) on which this was tested:

  • MacOS

@orpheuslummis orpheuslummis added the action/no-benchmark Skips the action that runs the benchmark. label Sep 16, 2022
@orpheuslummis orpheuslummis added this to the DefraDB v0.3.1 milestone Sep 16, 2022
@orpheuslummis orpheuslummis self-assigned this Sep 16, 2022
@orpheuslummis orpheuslummis changed the title docs: Clarify meaning of url parameter docs: Clarify meaning of url param., update in-repo CLI docs Sep 16, 2022
@codecov
Copy link

codecov bot commented Sep 16, 2022

Codecov Report

Merging #814 (7640cd6) into develop (f294f19) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #814   +/-   ##
========================================
  Coverage    59.67%   59.67%           
========================================
  Files          155      155           
  Lines        17283    17283           
========================================
  Hits         10313    10313           
  Misses        6044     6044           
  Partials       926      926           
Impacted Files Coverage Δ
config/configfile.go 75.00% <ø> (ø)
cli/root.go 47.67% <100.00%> (ø)

Copy link
Collaborator

@fredcarle fredcarle left a comment

Choose a reason for hiding this comment

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

LGMT 👍

Copy link
Member

@shahzadlone shahzadlone left a comment

Choose a reason for hiding this comment

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

LGTM.

One nitpick pre-merge: commit title has a dot followed by a comma (.,) would change that.

@orpheuslummis orpheuslummis changed the title docs: Clarify meaning of url param., update in-repo CLI docs docs: Clarify meaning of url param, update in-repo CLI docs Sep 18, 2022
@orpheuslummis orpheuslummis merged commit eccd4aa into develop Sep 18, 2022
@orpheuslummis orpheuslummis deleted the orpheus/refactor/url-params branch September 18, 2022 11:58
shahzadlone pushed a commit to shahzadlone/defradb that referenced this pull request Feb 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
action/no-benchmark Skips the action that runs the benchmark.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation to specify url of DefraDB node on remote installs
3 participants