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(audit): Update audit-logs.md #289

Merged
merged 2 commits into from
Oct 19, 2022
Merged

Conversation

joshua-goldstein
Copy link
Contributor

In dgraph/cmd/zero/run.go around L230, Zero.Conf.GetString("audit") only parses first subflag.
E.g. dgraph zero --audit output=audit-log-dir;compress=false;encrypt-file=enc-key is parsed as output=audit-log-dir, omitting the later arguments. I have run into this issue here but it is possibly a more general issue for superflags like alpha, zero, etc. An easy fix is to use quotes:

dgraph zero --audit "output=audit-log-dir;compress=false;encrypt-file=enc-key"

@skrdgraph
Copy link
Contributor

skrdgraph commented Sep 20, 2022

@MichelDiz is there a way to auto-generate these docs from the go project? Also, what was the reasoning for this to get moved to its own repo?

^ I need some clarifications here.

@skrdgraph skrdgraph self-requested a review September 20, 2022 08:16
@MichelDiz
Copy link
Contributor

is there a way to auto-generate these docs from the go project?

I think it is possible. But not sure how feaseble. e.g https://pkg.go.dev/search?q=dgraph-io&m= Some packages have these docs generated automatically I think. But those are package. Not sure if it is possible to generate for Dgraph binary.

Also, what was the reasoning for this to get moved to its own repo?

Really long story. In short the last team(new guys) wasn't happy with Docs inside the main repo. Manish was 100% against the moving, but he capitulated.

So the main reason was to deal with docs in a different cycle from the main repository.

@MichelDiz
Copy link
Contributor

@joshua-goldstein is this Eligible for v22.0.0? Can you pick it to master/main? And later cherry pick it to v22.0.0.

@joshua-goldstein joshua-goldstein changed the base branch from release/v21.12 to master October 3, 2022 06:22
@netlify
Copy link

netlify bot commented Oct 3, 2022

Deploy Preview for dgraph-docs-repo ready!

Name Link
🔨 Latest commit 2c824d4
🔍 Latest deploy log https://app.netlify.com/sites/dgraph-docs-repo/deploys/634a41b02d6c8900087b8665
😎 Deploy Preview https://deploy-preview-289--dgraph-docs-repo.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 settings.

@joshua-goldstein joshua-goldstein changed the base branch from master to release/v21.12 October 3, 2022 06:33
@joshua-goldstein joshua-goldstein changed the base branch from release/v21.12 to master October 3, 2022 06:33
@MichelDiz
Copy link
Contributor

PS. @joshua-goldstein now everything new needs to go to Main branch.

@joshua-goldstein joshua-goldstein changed the base branch from master to main October 15, 2022 05:14
@CLAassistant
Copy link

CLAassistant commented Oct 15, 2022

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@skrdgraph skrdgraph 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 👍

@skrdgraph skrdgraph merged commit 03e9319 into main Oct 19, 2022
@skrdgraph skrdgraph deleted the joshua/update-superflag-docs branch October 19, 2022 06:01
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

4 participants