every curl needs optional s, and admin port #859

brntbeer · 2015-09-11T17:29:45Z

I know we warn about this in a tip in the top, but it's so subtle and easily missed. Is there any reason not to include this elsewhere? cc @leefaus who was helping me with this!

cc @github/docs or @gjtorikian

I know we warn about this in a tip in the top, but it's so subtle and easily missed. Is there any reason not to include this elsewhere?

brntbeer · 2015-09-11T17:55:20Z

also, just noticed the tip at the top of the page, but it's SO easy to miss.

I guess alternatively you could change the{tip}{/tip} to be a {warning}{/warning} at the top.

gjtorikian · 2015-09-11T21:48:27Z

I'm definitely in favor of adding the admin_port to everything--thanks for that!

I'm not so sure about the http(s) bit, though. Is there any reason we can't just keep it as http, or https? I'm trying to think of the newbie admin who isn't entirely sure what the (s) means.

brntbeer · 2015-09-11T22:07:00Z

@gjtorikian not to mention, languages. maybe it'd look weird for certain people.

If the port is 8080, it should be known from set up that it's http, and 8443 for https. That's a decent compromise 😉

brntbeer · 2015-09-13T21:20:33Z

@gjtorikian i think we're set on this if you want to give it another look.

I also noticed some response Location sections missing <em> tags around hostname. and i added those admin_ports to them too

leefaus · 2015-09-14T14:11:32Z

👍 Thanks to all for helping on this. I think this will make it easier for enterprise customers to consume these endpoints.

gjtorikian · 2015-09-14T17:28:46Z

content/v3/enterprise/management_console.md

@@ -24,13 +24,13 @@ You need to pass your [Management Console password](https://help.github.com/ente
 Use the `api_key` parameter to send this token with each request. For example:

 <pre class="terminal">
-$ curl -L 'http://<em>hostname</em>/setup/api?api_key=<em>your-amazing-password</em>'
+$ curl -L 'http://<em>hostname</em>:<em>admin_port</em>:<em>admin_port</em>/setup/api?api_key=<em>your-amazing-password</em>'


Duplicated port info.

gjtorikian · 2015-09-14T17:29:20Z

One tiny comment; when that's fixed feel free to merge. Thanks!

brntbeer · 2015-09-14T17:37:39Z

@gjtorikian great catch! updated

brntbeer · 2015-09-17T03:06:26Z

@gjtorikian just caught something, in other examples for enterprise, we put (s). like on https://developer.github.com/v3/users/administration. Thoughts?

gjtorikian · 2015-09-17T05:15:04Z

Hmm. Since it's pointing to api.github.com, can we be bold and just switch 'em to https?

leefaus · 2015-09-17T20:09:38Z

@gjtorikian

Since the APIs are based on GitHub.com and on Enterprise customers, I think it would be valuable to call out both http and https as appropriate.

kdaigle · 2015-09-21T18:35:13Z

@gjtorikian can I get your 👍 on this if it is good with @leefaus' final comments? It looks like you have that last piece of outstanding feedback. 😄

MikeMcQuaid · 2015-09-22T06:56:59Z

content/v3/enterprise/management_console.md

@@ -24,13 +24,13 @@ You need to pass your [Management Console password](https://help.github.com/ente
 Use the `api_key` parameter to send this token with each request. For example:

 <pre class="terminal">
-$ curl -L 'http://<em>hostname</em>/setup/api?api_key=<em>your-amazing-password</em>'
+$ curl -L 'http://<em>hostname</em>:<em>admin_port</em>/setup/api?api_key=<em>your-amazing-password</em>'


Maybe console_port or mention admin_port specifically above?

gjtorikian · 2015-09-22T19:23:36Z

@gjtorikian can I get your 👍 on this if it is good with @leefaus' final comments? It looks like you have that last piece of outstanding feedback. 😄

I'm definitely against the existing http(s), but let's also definitely punt on that for this PR.

I firmly believe The Right Thing to Do™ is:

Change http(s) to https.
Change the Enterprise script to replace https with http.

We're already doing hella text substitutions whenever we generate the Enterprise docs, so we can add this one on too. I can take point for this work.

every curl needs optional s, and admin port

kdaigle · 2015-09-22T23:12:55Z

Thanks @gjtorikian! I merged this PR so you can tackle that work separately.

every curl needs optional s, and admin port

f0868f0

I know we warn about this in a tip in the top, but it's so subtle and easily missed. Is there any reason not to include this elsewhere?

brntbeer added 3 commits September 13, 2015 14:16

remove (s) from curl commands

74071af

response location should be <em>'d and have admin_port

277d62f

forgot to remove the last (s)

8630086

gjtorikian reviewed Sep 14, 2015
View reviewed changes

remove duplicate admin_port

83f0f99

MikeMcQuaid reviewed Sep 22, 2015
View reviewed changes

kdaigle added a commit that referenced this pull request Sep 22, 2015

Merge pull request #859 from github/admin_ports

15f3bd7

every curl needs optional s, and admin port

kdaigle merged commit 15f3bd7 into master Sep 22, 2015

kdaigle deleted the admin_ports branch September 22, 2015 23:12

gjtorikian mentioned this pull request Dec 17, 2015

Add -k flag and https to 2 examples #933

Merged

every curl needs optional s, and admin port #859

every curl needs optional s, and admin port #859

Uh oh!

Conversation

brntbeer commented Sep 11, 2015

Uh oh!

brntbeer commented Sep 11, 2015

Uh oh!

gjtorikian commented Sep 11, 2015

Uh oh!

brntbeer commented Sep 11, 2015

Uh oh!

brntbeer commented Sep 13, 2015

Uh oh!

leefaus commented Sep 14, 2015

Uh oh!

gjtorikian Sep 14, 2015

Choose a reason for hiding this comment

Uh oh!

gjtorikian commented Sep 14, 2015

Uh oh!

brntbeer commented Sep 14, 2015

Uh oh!

brntbeer commented Sep 17, 2015

Uh oh!

gjtorikian commented Sep 17, 2015

Uh oh!

leefaus commented Sep 17, 2015

Uh oh!

kdaigle commented Sep 21, 2015

Uh oh!

MikeMcQuaid Sep 22, 2015

Choose a reason for hiding this comment

Uh oh!

gjtorikian commented Sep 22, 2015

Uh oh!

kdaigle commented Sep 22, 2015

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.