coreos / quay-docs

Documentation for Quay.io

Documentation for Quay.io.

Run in a container (on prem)

docker run -p 4000:4000 quay.io/coreos/quay-docs

Run locally (development)

To edit using Jekyll:

jekyll serve --watch --baseurl=""

quay-docs's Issues

link to api docs from swagger endpoint

Documentation need for creating webhook notification via rest api

There doesn't seem to be any documentation on using the rest api to create a webhook notification via the REST api. I understand this page seems to indicate how to trigger, but the JSON on how to actually register a new webhook is not clear.
The qucli app is looking for a way to register a webhook via the restapi ticket: koudaiii/qucli#23 (comment)

It would be WONDERFUL if someone could add to the docs how to add a webhook via the rest api for a repository.

Please and Thank you.

Document TLS/Cert Chaining

Feature: Show API output without entering credentials

Currently, one must enter their credentials into quay API Explorer to see the output of an endpoint. I'm not 100% comfortable entering my credentials there...

I'm only a little familiar with swagger, but it would be really nice to see some json or some indication of what the endpoints will output.

Fix API screenshot of OAuth

We should update the screenshot of the OAuth applications page to the new UI and also document that you can only find the "Create Application" on organization's OAuth tab.

Wrong status code in swagger for successful invocation

Should be a 201, not a 200.

is there a way to use --build-arg during image build

I do not find anything about build-args in the docs. I guess they are not supported.
If they are not supported, would you mind pointing people into the right direction?

Use case: be able to support build date label:

BUILD_DATE=`date -u +"%Y-%m-%dT%H:%M:%SZ"` .

and in the Dockerfile:

LABEL org.label-schema.build-date=$BUILD_DATE

with

docker build --build-arg BUILD_DATE=`date -u +"%Y-%m-%dT%H:%M:%SZ"` .

Add with_toc_data back in once we fix the segfault

According to vmg/redcarpet#350, we might just need to update redcarpet

add a doc about updating QE

include information about migrations etc...

Add guide for adding custom fields to invoices

Quay Docs are very ADD-focused; best practices are to use COPY.

Dockerfile best practices say to prefer using COPY, but the Quay Repeatable Deployments page uses ADD exclusively, despite needing none of the special functionality of ADD.

Should probably replace those with COPY.

Feature Request: Display OAuth scope required for each API operation in the html

The API discovery endpoint already contains information about which implicit scope is required for each endpoint:

However, in the corresponding html shown on the generated API docs doesn't show the required scope anywhere that I can see.

It would be nice to list out the scopes somewhere in the html to more easily determine which scopes are necessary to grant to an OAuth application for a specific use case. Thanks Quay!

Document adding members to teams and the owners team

http://docs.quay.io/glossary/teams.html has nothing about these just yet.

Login quay.io with Github account failed

Failed to loging with Github account via https://quay.io/signin/.

Got response after click Continue

Bad Request
The browser (or proxy) sent a request that this server could not understand.

ReST API support

Quay is a very useful tool.

However it would be very pleasant to have ReST APIs - Specifically HTTP/1.1 GET for teams/repositories/container-commits etc.

Is this technically feasible?

Add documentation for 3-legged oauth, including token endpoint

We need to mention that you can swap a code for an access token at the following url, when using the authorization_code grant type: https://quay.io/oauth/access_token

No reference to CoreOS Enterprise Registry docs

There are no references to the Enterprise Registry documentation on the Quay.io documentation.

Add a CONTRIBUTING.md

Small update in online tutorial to reflect using busybox image instead of ubuntu:12.04

Small update to reflect using busybox image instead of ubuntu:12.04:

https://quay.io/tutorial

Step 2 states:

First we'll create a container with a single new file based off of the ubuntu base image:

should be

First we'll create a container with a single new file based off of the busybox base image:

and the resulting image should be:

busybox:latest

instead of

ubuntu:12.04

Tag re-pointing updating "latest" but not "develop" branch

Anybody know whats wrong here?

Add guide for using squashed images