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

Docs for the upcoming release #577

Merged
merged 50 commits into from Mar 1, 2018

Conversation

Projects
None yet
3 participants
@kbevers
Member

kbevers commented Sep 25, 2017

Essentially a duplicate of #563, this time on a branch in the project repository. This way it is easier for others to contribute as well. The overall structure of the docs are in place now, so feel free to correct existing text and add additional text.

Closes #442
Closes #454

Want to contribute to the version 5.0.0 docs?

Awesome! It's quite simple:

  • Clone the PROJ.4 repo
  • Check out the branch docs-release-4.10.0 (it was created before we decided on v. 5)
  • Document something
  • If you have commit access to the main repo, you can push your changes directly to this branch, otherwise you will have to make a pull request targeting the docs-release-4.10.0 branch. Please add [skip ci] to your commit messages (otherwise proj4.org will be updated with the v. 5.0.0 docs...).
  • Feel good about yourself for giving some much needed love to the PROJ.4 docs!

The reason the docs for 5.0.0 are maintained in a separate branch is that changes to the docs in the master branch get's pushed to proj4.org as soon as they land in master. Un-released features should not be documented on the website.

Readable version of the new docs: https://kbevers.github.io/

I try to keep this updated when new changes are made.

kbevers added some commits Aug 28, 2017

Major restructure and rewrite of docs.
A section on "Using PROJ.4" has been introduced giving a introduction
on how to use PROJ.4. The Parameters section has been removed and the
content reworked into other sections. Additionally the order of chapters
has been changed to provide a more complete and readable experience for
users of the documentation.
Added more pages to 'development' chapter. Moved old API description …
…to section named 'deprecated'. Created a quickstart page for the development chapter. Scaffolding in place for the rest of the chapter.
Moved projection list to using chapter and created a list of transfor…
…mations. Both are grouped in a section called operations.
@kbevers

This comment has been minimized.

Show comment
Hide comment
@kbevers

kbevers Sep 27, 2017

Member

Remember that a working copy of the docs can be seen at https://kbevers.github.io/

Member

kbevers commented Sep 27, 2017

Remember that a working copy of the docs can be seen at https://kbevers.github.io/

@kbevers kbevers referenced this pull request Oct 9, 2017

Closed

Documentation for pipelines #454

@kbevers kbevers referenced this pull request Feb 23, 2018

Merged

Tidy a few typos #815

kbevers and others added some commits Feb 23, 2018

datatypes.rst: linuistics + INFO datatypes
Some minor linguistic corrections + general update to make the documentation reflect the updates in PR #775
for a generation of Danish geodesists, colleague and collaborator for
two generations of global geodesists, Secretary General for the
International Association of Geodesy, IAG (1995--2007), fellow of the
Amercan Geophysical Union (1991), recipient of the IAG Levallois Medal

This comment has been minimized.

@mwtoews

mwtoews Feb 27, 2018

Contributor

s/Amercan/American/

@mwtoews

mwtoews Feb 27, 2018

Contributor

s/Amercan/American/

comprising more than 250 publications, and by his mentoring and teaching
of the next generations of geodesists.
As Christian was an avid Fortran programmer, and a keen Unix connoiseur,

This comment has been minimized.

@mwtoews

mwtoews Feb 27, 2018

Contributor

s/connoiseur/connoisseur/

@mwtoews

mwtoews Feb 27, 2018

Contributor

s/connoiseur/connoisseur/

@mwtoews

This comment has been minimized.

Show comment
Hide comment
@mwtoews

mwtoews Feb 27, 2018

Contributor

Some of the typos fixed in #815 should to be brought in here too.

Contributor

mwtoews commented Feb 27, 2018

Some of the typos fixed in #815 should to be brought in here too.

@kbevers

This comment has been minimized.

Show comment
Hide comment
@kbevers

kbevers Feb 27, 2018

Member

Some of the typos fixed in #815 should to be brought in here too.

I have merged those in, so they should be included already. Except maybe one or two due to a minor merge conflict.

Member

kbevers commented Feb 27, 2018

Some of the typos fixed in #815 should to be brought in here too.

I have merged those in, so they should be included already. Except maybe one or two due to a minor merge conflict.

kbevers added some commits Feb 28, 2018

Add section on PROJ resource files to docs [skip ci]
Added new section on PROJ resource files to the top level of the
documentation. Moved information on init-file from the 'usage'
chapter to the new section. Also moved pages on grids and HTPD to the
new resource files section. Finally links and information on the new
regional datumgrids packages is added.

@kbevers kbevers merged commit cb144b3 into master Mar 1, 2018

@kbevers kbevers deleted the docs-release-4.10.0 branch Mar 1, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment