Maneage -- Managing data lineage

Maneage: managing data lineage

Maneage is a framework for starting and growing projects, see these slides for an introduction. - Through Maneage, the complete data lineage of a project is recorded with its history and can easily be published or archived, enabling exact reproducibility. - Maneage is a recipient of the RDA Europe Adoption grant. -

Start building your project in Maneage

- To start a new project, simply run these commands to clone it from its Git repository. -


-git clone https://git.maneage.org/project.git     # Clone Maneage, default branch `maneage'.
-mv project my-project && cd my-project            # Set custom name and enter directory.
-git remote rename origin origin-maneage           # Rename remote server to use `origin' later.
-git checkout -b master                            # Make new `master' branch, start customizing.

- You are now ready to configure and make the raw template with the commands below. - If they are successful, you can start customizing it. -


-./project configure    # Build all necessary software from source.
-./project make         # Do the analysis (download data, run software on data, build PDF).

- See the Customization Checklist in the cloned README-hacking.md file for the next steps to start customizing Maneage for your project.

Merge/Pull requests

- As you continue customizing Maneage for your own project, you will notice generic improvements that can be useful for other projects too. - In such cases, please send us those changes to implement in the core Maneage branch and let them propagate to all projects using it. - If you look through the history of the Maneage branch, you'll notice many users have already started doing this, and this is how Maneage is planned to grow. - The recommended process is very similar to this forking tutorial. - Here is a summary: -

- Go to the maneage branch and create a new branch from there like below: -


-git checkout maneage
-git branch -b my-fix
-

Commit your fix over this new branch.

Build a new project on your favorite Git repository (GitLab, BitBucket, or GitHub for example) and assign it to a new Git remote in your project. - Let's call it my-remote. - You only need to do this once and keep this for future fixes.

Push your branch to that remote: -


-git push my-remote my-fix
-

Submit a link to your fork and the corresponding branch on Savannah. - If you are registered on Savannah, you can also submit it as a bug or a task.

+ + This file is part of Maneage. Maneage is free software: you can + redistribute it and/or modify it under the terms of the GNU General + Public License as published by the Free Software Foundation, either + version 3 of the License, or (at your option) any later version. + + Maneage is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. See + . --> + + + + + + + Maneage -- Managing data lineage + + + + + + + + + + + + + + + + + + + + +

+ + +

Maneage is a framework for starting and growing projects, see these slides for an introduction. + Maneage records the complete data lineage of a project with its history and can provide easy archiving or publishing. + This enables exact reproducibility. + Maneage has received the RDA Europe Adoption grant. +

+ +

Start building your project in Maneage

To start a new project, simply run these commands to clone it from its Git repository. +


+ git clone https://git.maneage.org/project.git     # Clone Maneage, default branch `maneage'.
+ mv project my-project && cd my-project            # Set custom name and enter directory.
+ git remote rename origin origin-maneage           # Rename remote server to use `origin' later.
+ git checkout -b master                            # Make new `master' branch, start customizing.
+

You are now ready to configure and make the raw template with the commands below. + If they are successful, you can start customizing it. +


+ ./project configure    # Build all necessary software from source.
+ ./project make         # Do the analysis (download data, run software on data, build PDF).
+

See the Customization Checklist in the cloned README-hacking.md file for the next steps to start customizing Maneage for your project. +

Merge/Pull requests

As you continue customizing Maneage for your own project, you will notice generic improvements that can be useful for other projects too. + In such cases, please send us those changes to implement in the core Maneage branch and let them propagate to all projects using it. + If you look through the history of the Maneage branch, you'll notice many users have already started doing this, and this is how Maneage is planned to grow. + The recommended process is very similar to + this forking tutorial. + Here is a summary: +

Go to the maneage branch and create a new branch from there like below: +


+ git checkout maneage
+ git branch -b my-fix
+

Commit your fix over this new branch.
Build a new project on your favorite Git repository (GitLab, BitBucket, or GitHub for example) and assign it to a new Git remote in your project. + Let's call it my-remote. + You only need to do this once and keep this for future fixes. +
Push your branch to that remote: + + git push my-remote my-fix + +
Submit a link to your fork and the corresponding branch on Savannah. + If you are registered on Savannah, you can also submit it as a bug or a task. +

+ +

+ + -- cgit v1.2.1

!!!Page under construction!!!