InternetSociety / ose-documentation

Documentation for the Internet Society's Open Standards Everywhere project
67 stars 22 forks source link

Add instructions to documents about how you can *use* the reference servers #9

Open danyork opened 4 years ago

danyork commented 4 years ago

Given that we have the four reference servers, we should think about how we can add information to the documentation about how someone can use the servers to see what "good" should look like. For example, to see the HTTP headers, at a Linux/Mac command line, you could type one of (this is "-vv" and then a capital "I" versus a 1 or lowercase "L"):

curl -vvI https://ose-apache.internetsociety.org/
curl -vvI https://ose-apache-cdn.internetsociety.org/
curl -vvI https://ose-nginx.internetsociety.org/
curl -vvI https://ose-nginx-cdn.internetsociety.org/

and you get back all the various HTTP headers. This shows what you should see from a "good" server. We could note this in the documentation, and potentially add on various grep or other commands to extract just the headers we want to show.

Similarly, we could suggest one of:

dig aaaa ose-apache-cdn.internetsociety.org
dig +short aaaa ose-apache-cdn.internetsociety.org

as a way of seeing the IPv6 records. (We may also want to include a web-based version of DIG for people who don't have it installed.)

A question could be - do we add something at the bottom of EACH of the pieces of documentation, with the relevant commands?

Or do we have a separate document that talks about using the reference servers to show these kind of commands?

(Or do we do both? And point to the separate document from the bottom of each individual document?)

eduardodiazrivera commented 4 years ago

Will this commands work for hosted services as well?

-ed

On Fri, May 22, 2020 at 11:22 AM Dan York notifications@github.com wrote:

Given that we have the four reference servers, we should think about how we can add information to the documentation about how someone can use the servers to see what "good" should look like. For example, to see the HTTP headers, at a Linux/Mac command line, you could type one of (this is "-vv" and then a capital "I" versus a 1 or lowercase "L"):

curl -vvI https://ose-apache.internetsociety.org/ curl -vvI https://ose-apache-cdn.internetsociety.org/ curl -vvI https://ose-nginx.internetsociety.org/ curl -vvI https://ose-nginx-cdn.internetsociety.org/

and you get back all the various HTTP headers. This shows what you should see from a "good" server. We could note this in the documentation, and potentially add on various grep or other commands to extract just the headers we want to show.

Similarly, we could suggest one of:

dig aaaa ose-apache-cdn.internetsociety.org dig +short aaaa ose-apache-cdn.internetsociety.org

as a way of seeing the IPv6 records. (We may also want to include a web-based version of DIG for people who don't have it installed.)

A question could be - do we add something at the bottom of EACH of the pieces of documentation, with the relevant commands?

Or do we have a separate document that talks about using the reference servers to show these kind of commands?

(Or do we do both? And point to the separate document from the bottom of each individual document?)

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/InternetSociety/ose-documentation/issues/9, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAOCH5KODBIWWKX2YPPU2X3RS2KDNANCNFSM4NH4X5KQ .

-- NOTICE: This email may contain information which is confidential and/or subject to legal privilege, and is intended for the use of the named addressee only. If you are not the intended recipient, you must not use, disclose or copy any part of this email. If you have received this email by mistake, please notify the sender and delete this message immediately.