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

Docker documentation update #547

Merged
merged 4 commits into from
Nov 6, 2017

Conversation

ricardogsilva
Copy link
Member

@ricardogsilva ricardogsilva commented Oct 30, 2017

Overview

This PR adds documentation on how to use pycsw's official Docker image, which has recently been merged with #534

Related Issue / Discussion

#530
#534

Additional Information

Contributions and Licensing

(as per https://github.com/geopython/pycsw/blob/master/CONTRIBUTING.rst#contributions-and-licensing)

  • I'd like to contribute [feature X|bugfix Y|docs|something else] to pycsw. I confirm that my contributions to pycsw will be compatible with the pycsw license guidelines at the time of contribution.
  • I have already previously agreed to the pycsw Contributions and Licensing Guidelines

@ricardogsilva ricardogsilva requested a review from kalxas October 30, 2017 23:49
@codecov
Copy link

codecov bot commented Oct 31, 2017

Codecov Report

Merging #547 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #547   +/-   ##
=======================================
  Coverage   55.93%   55.93%           
=======================================
  Files          29       29           
  Lines        6338     6338           
  Branches     1342     1342           
=======================================
  Hits         3545     3545           
  Misses       2413     2413           
  Partials      380      380
Flag Coverage Δ
#integrationtests 54.57% <ø> (ø) ⬆️
#unittests 7.63% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c182204...f0679d5. Read the comment docs.

@ricardogsilva ricardogsilva mentioned this pull request Nov 5, 2017
2 tasks
@ricardogsilva ricardogsilva changed the title [WIP] Docker documentation update Docker documentation update Nov 5, 2017
@ricardogsilva
Copy link
Member Author

@kalxas

This is now ready for review. However, it is dependent on merging #548, as some of the docs already mention the improvements of the other PR.

@ricardogsilva
Copy link
Member Author

I've requested a review also from @tomkralidis as he seems to be in charge of docs ;)

@kalxas
Copy link
Member

kalxas commented Nov 5, 2017

thanks @ricardogsilva I will review and merge #548 first

@tomkralidis
Copy link
Member

tomkralidis commented Nov 5, 2017

@ricardogsilva really nice work here. I see you made the docker docs as its own page that is included by installation.rst. Should the Docker section simply be in installation.rst or should we have the docker page as a first order navigation (parallel to installation.rst)? I'd prefer the former latter given it covers both installing and deployment?

@tomkralidis
Copy link
Member

Sorry I meant I prefer the latter.

@ricardogsilva
Copy link
Member Author

@tomkralidis I wasn't sure where to put these new docs. Ended up putting them under installation but was kind of hoping for some direction. I'll move them to their own section then. Where would they fit in? Right after installation? After administration?

@tomkralidis
Copy link
Member

@ricardogsilva let's go with right after installation?

@ricardogsilva
Copy link
Member Author

OK, I'll update

@ricardogsilva
Copy link
Member Author

@tomkralidis

I've made the change, ready for re-review

@tomkralidis tomkralidis merged commit 5bbdc02 into geopython:master Nov 6, 2017
@tomkralidis
Copy link
Member

Thanks @ricardogsilva!

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.

3 participants