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

development documentation #4697

Merged
merged 1 commit into from
Jun 16, 2020
Merged

Conversation

jodygarnett
Copy link
Contributor

@jodygarnett jodygarnett commented May 18, 2020

Development documentation is currently split between codebase, wiki and the user manual.

I would like to resolve this according to direction from the core-geonetwork README:

Developer documentation is also in the docs submodule but is being migrated out of that project into the Readme files in each module in the project. General documentation for the project as a whole is in this Readme and module specific documentation can be found in
each module (assuming there is module specific documentation required).

Bringing all the developer docs into a series of README.md files is too much for one commit, here are the first couple changes:

  • updates build instructions for IntilliJ
  • Offers a few more creature comforts like markdown CONTRIBUTING.md and LICENSE.md files
  • copy over build from source code instructions

This PR allows draft edits by maintainers so please just edit the pages directly in GitHub (rather than cycle through the review process).

Notes:

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@jodygarnett jodygarnett marked this pull request as ready for review June 12, 2020 02:20
@jodygarnett
Copy link
Contributor Author

I was reminded of this PR checking out 3.10.x and finding outdated instructions.

@jodygarnett
Copy link
Contributor Author

@juanluisrp are you in position to review?

@jodygarnett
Copy link
Contributor Author

I have squashed history making this easier to apply

@josegar74 josegar74 merged commit 5ee19a2 into geonetwork:master Jun 16, 2020
josegar74 pushed a commit that referenced this pull request Jun 16, 2020
pmauduit pushed a commit to pmauduit/core-geonetwork that referenced this pull request Sep 29, 2020
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