Skip to content
This repository was archived by the owner on Sep 1, 2022. It is now read-only.

Commit 486d58c

Browse files
committed
add installation notes
1 parent a9d17ad commit 486d58c

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

server-installation-notes.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## GitHub Enterprise Server (GHES) installation notes
2+
3+
⚠️ | This course uses features not yet supported by GHES.
4+
--- | ---
5+
6+
This course makes use of [suggested changes](https://github.blog/changelog/2018-10-16-suggested-changes/), a feature that is currently in beta for GitHub.com but not available on GHES. Courses will still work, but suggested changes will appear as pull request comments with the syntax:
7+
<code>
8+
```suggestion
9+
A suggestion
10+
```
11+
</code>
12+
13+
### Course dependencies
14+
15+
The following are dependencies of the course. The course may continue to work without these dependencies, but learners won't experience the course as designed.
16+
17+
| Dependency | Required? | Reason | Alternative |
18+
|--------------------------------------------------------------------------------------------------------------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
19+
| GHES must be able to reach githubusercontent.com | Yes | Images used throughout the course are served from this domain. Learners will find broken images required to take the course without this access. | Manually download the images referenced in the `responses/` folder, upload them to an accessible domain, and replace the images in the `responses/` folder. |
20+
| Learner must be able to reach github.com and outside web | No | Links are provided to resources that live on the outside web. | Without access to resources on the outside web, learners will reach blocked resources. You can change the links to these resources in the `responses/` folder, and in the template repository. |

0 commit comments

Comments
 (0)