Add manifest of files maintained elsewhere

The plan is for this file to be used by a CI process which
will fail a PR if it includes changes to any of these files.
This commit is contained in:
Misty Stanley-Jones 2016-10-14 09:49:18 -07:00
parent 943c8dfc0b
commit 384335a46e
2 changed files with 35 additions and 1 deletions

29
.NOT_EDITED_HERE.txt Normal file
View File

@ -0,0 +1,29 @@
# Files and directories here are not edited in the docker.github.io repo.
# Instead, they are edited in the appropriate upstream repo and pulled
# into this repo periodically. The intent is that if you submit a PR
# with changes to these files or directories, a CI job will fail in the
# PR, indicating that it should not be merged.
# If you need to edit these files or directories, submit a PR in one of the
# following repos. The file will probably be located within the docs/ subdirectory.
# docker-trusted-registry: n/a, file an issue
# engine: https://github.com/docker/docker
# compose: https://github.com/docker/compose
# notary: https://github.com/docker/notary
# registry: https://github.com/docker/distribution
# swarm: https://github.com/docker/swarm
# ucp: n/a, file an issue
# Make sure directories have the trailing slash, keep the list alphabetical
apidocs/
compose/reference/
docker-trusted-registry/reference/
engine/reference/
machine/reference/
notary/reference/
registry/configuration.md
registry/spec/
swarm/reference/
ucp/reference/

View File

@ -2,8 +2,13 @@
guidelines to help us review it. You can remove these comments
as you fill out this template. -->
<!--DO NOT edit files and directories listed in .NOT_EDITED_HERE.txt
as these are maintained in upstream repos and added to the central
docs repo periodically. Your PR will fail automated checks if it
includes changes to these files or directories.-->
<!-- **Squash your commits**: Please use an
[interactive rebase](https://help.github.com/articles/about-git-rebase/)
interactive rebase (https://help.github.com/articles/about-git-rebase/)
to squash (combine) multiple commits into a single commit, to keep the
commit history clean. The exception is when commits from multiple
contributors exist in the same pull request. In that case, one commit