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.

Sign up for GitHub

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

Jump to bottom

docs: Update docs for the v0.5 release #1320

Merged
merged 6 commits into from
Apr 11, 2023
Merged

docs: Update docs for the v0.5 release #1320

merged 6 commits into from
Apr 11, 2023

Conversation

orpheuslummis
Copy link
Contributor

@orpheuslummis orpheuslummis commented Apr 10, 2023 •
edited
Loading

Relevant issue(s)

Resolves #1171

Description

Update in-repo docs in light of release v0.5.

  • readme overhaul
  • contributing guide update
  • ensure code examples are correct
  • add autogenerated cli 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?

Human readers.

@orpheuslummis orpheuslummis added documentation Improvements or additions to documentation action/no-benchmark Skips the action that runs the benchmark. labels Apr 10, 2023
@orpheuslummis orpheuslummis added this to the DefraDB v0.5 milestone Apr 10, 2023
@orpheuslummis orpheuslummis self-assigned this Apr 10, 2023
@orpheuslummis orpheuslummis changed the title Orpheus/docs/v0.5 docs: Update docs for the v0.5 release Apr 10, 2023
islamaliev
islamaliev reviewed Apr 11, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
@orpheuslummis orpheuslummis marked this pull request as ready for review April 11, 2023 15:20
AndrewSisley
AndrewSisley approved these changes Apr 11, 2023
View reviewed changes
Copy link
Contributor

@AndrewSisley AndrewSisley left a comment

Choose a reason for hiding this comment

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

praise: Looks really good - thank you for taking the time to go over this.

Approving now with a few minor comments added

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
docs/cli/defradb_start.md Outdated
--no-p2p Disable the peer-to-peer network synchronization system
--p2paddr string Listener address for the p2p network (formatted as a libp2p MultiAddr) (default "/ip4/0.0.0.0/tcp/9171")
--peers string List of peers to connect to
--privkeypath string Path to the private key for tls (default "/home/jsimnz/.defradb/certs/server.crt")
--pubkeypath string Path to the public key for tls (default "/home/jsimnz/.defradb/certs/server.key")
--privkeypath string Path to the private key for tls (default "/Users/o/.defradb/certs/server.crt")
Copy link
Contributor

@AndrewSisley AndrewSisley Apr 11, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

suggestion: This looks inaccurate, suggest changing to $HOME/.defradb/...... or perhaps $DEFRA_ROOTDIR/.defradb/......? I'm not sure about the behaviour here though.

(same goes for the line below too)

Copy link
Member

Choose a reason for hiding this comment

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

I prefer $HOME.
What is $DEFRA_ROOTDIR, do we maintain exporting this properly?

Copy link
Member

Choose a reason for hiding this comment

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

Btw: here is what above in the docs it shows:

--rootdir string Directory for data and configuration to use (default "$HOME/.defradb")

Copy link
Contributor

Choose a reason for hiding this comment

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

I prefer $HOME. What is $DEFRA_ROOTDIR, do we maintain exporting this properly?

It is documented in the config file template, but it might actually be out of date - the only other ref I can see to it is a test that looks like it might not be testing what it says it is (TestLoadValidationEnvDoesntSupportRootdir - The call to FixtureEnvKeyValue looks like it has no impact on the test)

Copy link
Contributor

Choose a reason for hiding this comment

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

#1327

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah - the test is a negative test, but I'll remove it as we could test an almost infinite amount of unsupported environment variables.

Copy link
Contributor

Choose a reason for hiding this comment

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

Orpheus has actually already removed the reference to this from the template in #1318

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think this is an anomaly of how we treat paths in the current config system. I'd like to do/see a refactor in v0.6 which would allow writing relative paths in the default config file and docs.

shahzadlone
shahzadlone reviewed Apr 11, 2023
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Apr 11, 2023 •
edited
Loading

Codecov Report

Merging #1320 (551df7d) into develop (1c80e10) will increase coverage by 0.03%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #1320      +/-   ##
===========================================
+ Coverage    70.65%   70.68%   +0.03%     
===========================================
  Files          184      184              
  Lines        17803    17803              
===========================================
+ Hits         12578    12584       +6     
+ Misses        4272     4269       -3     
+ Partials       953      950       -3

see 4 files with indirect coverage changes

@orpheuslummis orpheuslummis merged commit 2d27a10 into develop Apr 11, 2023
@orpheuslummis orpheuslummis deleted the orpheus/docs/v0.5 branch April 11, 2023 23:23
@jsimnz jsimnz mentioned this pull request Apr 12, 2023
Merged
4 tasks
shahzadlone pushed a commit that referenced this pull request Apr 13, 2023
@orpheuslummis @shahzadlone
docs: Update docs for the v0.5 release (#1320)
92061f0
shahzadlone pushed a commit to shahzadlone/defradb that referenced this pull request Feb 23, 2024
@orpheuslummis
docs: Update docs for the v0.5 release (sourcenetwork#1320)
ebb7d87
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AndrewSisley AndrewSisley AndrewSisley approved these changes

@shahzadlone shahzadlone shahzadlone left review comments

@islamaliev islamaliev islamaliev left review comments

Assignees

@orpheuslummis orpheuslummis

Labels
action/no-benchmark Skips the action that runs the benchmark. documentation Improvements or additions to documentation
Projects
None yet
Milestone
DefraDB v0.5
Development

Successfully merging this pull request may close these issues.

Repository documentation update v0.5
4 participants
@orpheuslummis @islamaliev @shahzadlone @AndrewSisley