Expose upload_rm option in the documentation

[ximenesuk]

This is a doc change explaining the upload_rm cli import option. It was originally written as a 5.0.4 fix and so made minimal changes to pages. It may be that for 5.1 we will want to further re-organise the import pages.

@sbesson This needs the file /downloads/inplace/advanced-help.txt pulling in from somewhere. Is there an automatic way to do this?

[sbesson]

@ximenesuk: you can either cherry-pick the commit auto-generated by OMERO-5-1-merge-docs-autogen after ome/openmicroscopy#2999 is included into the merge build or wait until this upstream PR is merged into develop and use the commit auto-generated by OMERO-5.1-latest-docs-autogen.

[ximenesuk]

@sbesson Thanks! I'll wait on this one being merged. Hopefully that won't be a problem but I won't tempt fate.

[mtbc]

awfully long underline

[ximenesuk]

Hmm, I think the heading may have been shortened!

[mtbc]

Staged at http://www.openmicroscopy.org/site/support/omero5.1-staging/sysadmins/in-place-import.html and http://www.openmicroscopy.org/site/support/omero5.1-staging/sysadmins/import-scenarios.html.

[mtbc]

good catch

[mtbc]

Is this still actually true if upload_rm isn't in-place?

[ximenesuk]

You mean the use of "only"? Probably not completely true, now.

[sbesson]

@ximenesuk see snoopycrimecop@85b1ce2

[ximenesuk]

Thanks @sbesson - there's no problem with that commit including other changes?

[sbesson]

@ximenesuk: no, it should be fine. This commit should only include changes which have been merged in the upstream repository.

[sbesson]

http://www.openmicroscopy.org/site/support/omero5.1-staging/sysadmins/in-place-import.html#getting-started looks good.

[ximenesuk]

@mtbc Any further comments on the changes?

[mtbc]

I'd still add a couple of "much faster" words for https://github.com/openmicroscopy/ome-documentation/pull/975/files#r16982141 but apart from that the latest changes look good.

[jburel]

Please read and understand the implications of the ln_rm option.
I will replace by
Please read carefully the implications of using the ln_rm option.

[ximenesuk]

@jburel Although this line is from the orignal page (ie I didn't think to address it in this PR) it could do with tweaking. However, I'm not sure that they are reading the implications but making them based on reading the docs. So maybe something more like:

Please read carefully <link to "ln_rm" section just above> to fully understand the implications of using the this option.

/cc @joshmoore

[jburel]

@ximenesuk: your suggestion really highlights the fact that people need to be careful. (excluding the "the this")

[hflynn]

I'd favour Please read <link> carefully to ensure you fully understand the implications of using this option.

[ximenesuk]

I'm happy with Helen's wording. My "the this" was a typo - honest :-)

[ximenesuk]

Better? The link looks a bit odd as we have used quotes and lower case in the various subheadings. The subheadings might be better rewritten but at the same time I don't really want this PR to last for ever :-)

[hflynn]

Looks fine to me, are we ready to merge now?

[jburel]

I think so.

[hflynn]

Is there a plan to rebase the code for this if we do a 5.0.5 for OMERO?

[joshmoore]

I'd leave that at your discretion, @hflynn, though will have to be fairly careful with the likes of --summary (i.e. 5.1 features slipping in)

[hflynn]

Ok, probably safer to leave it then.

[hflynn]

--no-rebase