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

docs for project updates SOP #386

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Conversation

amnonkhen
Copy link
Contributor

@amnonkhen amnonkhen commented Jul 22, 2021

see ebi-ait/dcp-ingest-central#13, ebi-ait/dcp-ingest-central#349

The initial version of this branch contains draft changes by @clairerye done on Google Docs.

@amnonkhen amnonkhen marked this pull request as draft July 22, 2021 16:48
Copy link
Contributor

@ke4 ke4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can see that it is a WIP PR. I suggested some change requests.

# How to Update a Project

## Definitions:

*Update* - Any edit to a project, could include editing a typo, adding/deleting metadata or data, changing how entities are linked
*Update* - Any edit to a project, could include editing a typo, adding/overwriting metadata or data, changing how entities are linked
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are you removing deleting?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

because we cannot communicate a deletion. deletions are out of scope at the moment

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is true at the moment!

@@ -23,16 +31,12 @@ UNDER REVIEW
Things that can be done:
* Fix an error in any existing field
* Enter information into any blank field in an existing entity
* Add new metadata entities and sequence files
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are you removing this sentence?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we cannot add new sequence files via updates, they should be added via additions

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add "Modify existing processes and create new processes"

@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure we need this file in the repository

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this iml file?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is the IntelliJ IDE project file.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can be removed.

* Change the 'DescribedBy' field
* Delete anything from a submission

### When can I update a project?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is these lines removed by accident?

@@ -51,9 +55,8 @@ Things that can’t be done: (?)
1. If the project is already in the 'Needs Update' piepeline, then assign yourself to the project and follow the steps below to make the necessary changes. Refer to the primary wrangler to ensure there are no other outstanding changes that need to be made.

## Updating a project in ingest and DCP
Note that Adding Metadata Entities and Sequence Files can only be done using a spreadsheet, and requires a new submission.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you wanted to change this line to something else but you forgot to add it?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm. Maybe I just deleted it by accident. That sounds correct to me

Copy link
Collaborator

@ESapenaVentura ESapenaVentura left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are many things that need to be written here, can't review yet

@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this iml file?

@@ -23,16 +31,12 @@ UNDER REVIEW
Things that can be done:
* Fix an error in any existing field
* Enter information into any blank field in an existing entity
* Add new metadata entities and sequence files
* schema??

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure what this means?

Comment on lines +1 to +12
<?xml version="1.0" encoding="UTF-8"?>
<module type="PYTHON_MODULE" version="4">
<component name="NewModuleRootManager" inherit-compiler-output="true">
<exclude-output />
<content url="file://$MODULE_DIR$" />
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
</component>
<component name="PackageRequirementsSettings">
<option name="requirementsPath" value="" />
</component>
</module>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<?xml version="1.0" encoding="UTF-8"?>
<module type="PYTHON_MODULE" version="4">
<component name="NewModuleRootManager" inherit-compiler-output="true">
<exclude-output />
<content url="file://$MODULE_DIR$" />
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
</component>
<component name="PackageRequirementsSettings">
<option name="requirementsPath" value="" />
</component>
</module>

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.

6 participants