Adding resources for getting started with GraphiQL on Enterprise - #141
Conversation
|
|
||
|
|
||
| #### Setup | ||
| The example is already setup with all source files necessary to work with Pages on GitHub Enterprise. You can copy this folder as-is to your own instance, then [configure GitHub Pages to publish the master branch](https://help.github.com/enterprise/user/articles/configuring-a-publishing-source-for-github-pages/). A URL will be created for you automatically. |
There was a problem hiding this comment.
This might need more details. I'm not sure what * copy this folder as-is to your own instance* really means.
There was a problem hiding this comment.
How about just an example of cloning it and pushing it to a new remote on your own instance of GHE?
There was a problem hiding this comment.
@tcbyrd Cloning the whole platform-samples repository?
There was a problem hiding this comment.
@azizshamim Good point. Basically you'd need to copy github/platform-samples/graphql/enterprise. I have all this in its own repo on our internal GHE instance, but wanted to make it available publicly, but yeh having to clone this entire repo isn't a good workflow. Should I just make a public repo in my own account and link to it from here instead?
There was a problem hiding this comment.
@tcbyrd I think that might be a bit too much redirection. One of these two options might be enough:
- Document how to clone just the single directory in the repository with
sparse-checkout - List the files that they need from a clone of the repository.
There was a problem hiding this comment.
@azizshamim Even with sparse-checkout it's retaining the directory structure, so you'd still have to move all the files into the root of the new repo. I adjusted the wording to be more explicit that you need the entire graphql/enterprise directory in its own repo.
This PR adds examples of how to use GraphiQL with GitHub Enterprise, which is now available in 2.10.0.
Includes a README with instructions for the Electron-based GraphiQL App as well as an example that can be published from GitHub Pages.