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

add nginx/haproxy connect example documentation #1306

Merged
merged 1 commit into from
Nov 14, 2019

Conversation

eikenb
Copy link
Contributor

@eikenb eikenb commented Nov 9, 2019

includes helper script to extract config files and run command in screen
session.

@eikenb eikenb added docs consul Related to the Consul integration labels Nov 9, 2019
@eikenb eikenb added this to the 0.23.0 - Consul Connect milestone Nov 9, 2019
@eikenb eikenb requested a review from a team November 9, 2019 00:25
@eikenb eikenb force-pushed the issue-1262-consul-connect-docs branch 5 times, most recently from f183d27 to 269b1e0 Compare November 9, 2019 01:34
@eikenb eikenb force-pushed the issue-1262-consul-connect-docs branch from 269b1e0 to b2dd438 Compare November 13, 2019 01:16
@eikenb
Copy link
Contributor Author

eikenb commented Nov 13, 2019

Thanks for all the suggestions @kaitlincarter-hc! Super helpful and nice of you.

I've made all the suggested text changes except regarding the script/config-files. Regard them, I went back and forth on having the config files already in the repo vs. having them generated by the script. There are a couple(ish) options.

  1. Have a sub-directory with the all the config files and templates (the things the script generates from the doc) already in place and use the script to keep it in sync with the doc (update the doc then extract the files to test/save).

  2. Only have the script and let the users generate the files themselves for testing.

I went with the 2 as it kept things cleaner and I figured if the person was technical enough to run the tests, they could figure out how to use the script.

Switching to 1 would, I think, make it easier to run the tests at the expense of cluttering things up a bit. I would split the script into 2 parts if I did that. One to extract the config and template files and one to actually run the tests (which would also simplify it a bit).

Do you think 1 would be better?

Thanks again.

@kaitlincart
Copy link

kaitlincart commented Nov 13, 2019

I think for the repo, option 2 is probably better. For the Learn guide I'll simplify things a little!

@eikenb eikenb force-pushed the issue-1262-consul-connect-docs branch 2 times, most recently from 81b6032 to 2b46da7 Compare November 14, 2019 00:01
includes helper script to extract config files and run commands in
screen session.
@eikenb eikenb force-pushed the issue-1262-consul-connect-docs branch from 2b46da7 to 6dfd298 Compare November 14, 2019 00:03
@eikenb
Copy link
Contributor Author

eikenb commented Nov 14, 2019

Made a few tweaks and included the haproxy doc (which was based on nginx one and nearly identical... so I figured it has already been reviewed).

@eikenb eikenb merged commit 5cf9d68 into master Nov 14, 2019
@eikenb eikenb deleted the issue-1262-consul-connect-docs branch November 14, 2019 00:04
@eikenb eikenb changed the title add nginx connect example documentation add nginx/haproxy connect example documentation Nov 14, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
consul Related to the Consul integration docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants