Skip to content

chore(external docs): Document dependencies#4547

Merged
binarylogic merged 9 commits intomasterfrom
resources
Oct 14, 2020
Merged

chore(external docs): Document dependencies#4547
binarylogic merged 9 commits intomasterfrom
resources

Conversation

@binarylogic
Copy link
Contributor

Signed-off-by: binarylogic bjohnson@binarylogic.com

Signed-off-by: binarylogic <bjohnson@binarylogic.com>
@binarylogic binarylogic requested a review from fanatid as a code owner October 13, 2020 20:58
Copy link
Member

@jszwedko jszwedko left a comment

Choose a reason for hiding this comment

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

👍 I like this structured content, but it isn't immediately clear to me when something should be "dependency" vs. "setup" vs. a "how it works" section. For example, there seems to be some overlap between what might have been a "dependency" section in the docker source and the "setup" section.

Or the apache section could have equally been written as a "setup" section with steps like:

  • Make sure apache is running
  • Edit the httpd.conf file and add the mod_status line
  • Reload apache
  • Verify that you can curl the endpoint

Maybe we should just have "setup" and drop "dependency"?

`DOCKER_VERIFY_TLS` are set (as well as other Docker environment variables).
See the [Docker daemon docs][urls.docker_daemon_socket_option].
If you'd prefer not to collect Docker logs through the Docker
API Vector offers alternative strategies. In some sets
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
API Vector offers alternative strategies. In some sets
API Vector offers alternative strategies.

@binarylogic
Copy link
Contributor Author

Yeah, this is very much in flux. I pushed it up to get your opinion on the dependency block, I plan to drop the setup block as well as the redundant how_it_works sections.

My goal is to remove as much of the writing as possible since it'll be difficult to ensure quality and consistency across a team of developers.

Signed-off-by: binarylogic <bjohnson@binarylogic.com>
Signed-off-by: binarylogic <bjohnson@binarylogic.com>
Signed-off-by: binarylogic <bjohnson@binarylogic.com>
Signed-off-by: binarylogic <bjohnson@binarylogic.com>
@binarylogic binarylogic requested a review from bruceg as a code owner October 14, 2020 01:03
Signed-off-by: binarylogic <bjohnson@binarylogic.com>
Signed-off-by: binarylogic <bjohnson@binarylogic.com>
Signed-off-by: binarylogic <bjohnson@binarylogic.com>
@binarylogic binarylogic requested a review from MOZGIII as a code owner October 14, 2020 03:23
Signed-off-by: binarylogic <bjohnson@binarylogic.com>
@binarylogic binarylogic merged commit 6bb98da into master Oct 14, 2020
@binarylogic binarylogic deleted the resources branch October 14, 2020 14:00
mengesb pushed a commit to jacobbraaten/vector that referenced this pull request Dec 9, 2020
Signed-off-by: Brian Menges <brian.menges@anaplan.com>
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.

2 participants