Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove old documentation source, add README on migration #1985

Merged
merged 2 commits into from
Oct 14, 2016

Conversation

johndmulhausen
Copy link
Contributor

For more information on this migration, see https://blog.docker.com/2016/09/announcing-new-docs-repo-github/

Signed-off-by: John Mulhausen john@docker.com

@RichardScothern
Copy link
Contributor

RichardScothern commented Oct 5, 2016

hi @johndmulhausen

docs/spec/api.md.tmpl is used to generate docs/spec/api.md so I would like to keep these files in this repo.

The build error is unrelated to this change and can be ignored.

@dmcgowan
Copy link
Collaborator

dmcgowan commented Oct 5, 2016

Can we keep all of docs/spec/ in this repo, don't mind sending updates over to the docs repo as well but we use those files to review design proposals.

@johndmulhausen
Copy link
Contributor Author

@dmcgowan Absolutely! Let me update the PR

@johndmulhausen
Copy link
Contributor Author

johndmulhausen commented Oct 10, 2016

@RichardScothern @dmcgowan spec is back. :)

@johndmulhausen
Copy link
Contributor Author

@RichardScothern @dmcgowan Signed! Also; can I remove spec/api.md.tmpl from our repo if you're keeping it over here?

@RichardScothern
Copy link
Contributor

@johndmulhausen spec/api.md.tmpl is not human consumable document so it should not be in the docs repository

@RichardScothern
Copy link
Contributor

LGTM
@dmcgowan

johndmulhausen added a commit to docker/docs that referenced this pull request Oct 11, 2016
@johndmulhausen
Copy link
Contributor Author

@RichardScothern Thanks! Removed api.md.tmpl in the docs repo.
@dmcgowan Does this seem okay?

@stevvooe
Copy link
Collaborator

Should the reference doc docs/configuration.md been moved? That needs to stay in sync with the configuration package. I didn't think we were moving reference material. I also have the same concern about storage drivers.

We may want to have a top-level spec directory for the specification content.

Will these be moved over to the new repo preserving history?

@mdlinville
Copy link
Contributor

Yes, the history was preserved. If additional things need to be excluded from the PR, I'll carry it since @johndmulhausen is on vacation.

johndmulhausen and others added 2 commits October 13, 2016 11:49
Signed-off-by: John Mulhausen <john@docker.com>
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
@mdlinville
Copy link
Contributor

@stevvooe @RichardScothern @dmcgowan PTAL again. I squashed John's commits and added back the configuration.md, and added a little more to the README.

@codecov-io
Copy link

Current coverage is 50.88% (diff: 100%)

Merging #1985 into master will decrease coverage by 10.13%

@@             master      #1985   diff @@
==========================================
  Files           125        125           
  Lines         11136      11136           
  Methods           0          0           
  Messages          0          0           
  Branches          0          0           
==========================================
- Hits           6795       5666   -1129   
- Misses         3453       4723   +1270   
+ Partials        888        747    -141   

Powered by Codecov. Last update 252cc27...3ac8dea

@stevvooe
Copy link
Collaborator

LGTM

I'm still not sure that we should move the storage driver docs. They are very much implementation specific and keeping them in sync has been hard enough with them in the same repo. I really think we need a better division between what is reference material vs what are downstream docs.

@RichardScothern
Copy link
Contributor

LGTM.

I can see arguments for keeping them, and also for moving them with the other docs. Let's just leave this as-is and as maintainers we'll be mindful to ensure any code changes which require documenting include a PR to the docs branch.

@mdlinville mdlinville merged commit c372264 into distribution:master Oct 14, 2016
thaJeztah pushed a commit to thaJeztah/distribution that referenced this pull request Apr 22, 2021
Deleting per comments in distribution#1985
thaJeztah pushed a commit to thaJeztah/distribution that referenced this pull request Jan 19, 2022
Deleting per comments in distribution#1985
dylanrhysscott pushed a commit to digitalocean/docker-distribution that referenced this pull request Jan 5, 2023
Deleting per comments in distribution#1985
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants