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

Training update april 13 1 #346

Merged
merged 4 commits into from
Jun 3, 2013
Merged

Training update april 13 1 #346

merged 4 commits into from
Jun 3, 2013

Conversation

gusferguson
Copy link

Updates to screenshots in getting-started.txt, managing-data.txt, viewing-data.txt and scripts.txt. Adding orphaned images to Insight, new import window and other minor changes.

@joshmoore
Copy link
Member

Patch size is 2.4MB (wget https://github.com/openmicroscopy/ome-documentation/pull/346.patch). Ok, but not great. What was the status on moving these out of the repository?

@gusferguson
Copy link
Author

@joshmoore
No progress as far as I know. For me it would be a lot easier to have the images on an external site that is referenced by the text in the repository. It just needs the technical issues to be ironed out and a place for the images found.

@hflynn
Copy link
Member

hflynn commented Apr 26, 2013

We have talked about moving them to squig with @jburel but I don't know what is required to actually get this done. I guess the question is, can we put this off until after Paris or does it need sorting sooner than that?

@hflynn
Copy link
Member

hflynn commented Apr 26, 2013

Changes all look very minor to me - for consistencies sake rather than actually changing any steps in the guides so we could hold off and move the images first. What do you want to do @joshmoore ?

@gusferguson
Copy link
Author

@hflynn
I have no objections

@joshmoore
Copy link
Member

@gusferguson: are all of the images somewhere on necromancer? If so, we could attempt to modify the jobs to use those files.

@joshmoore
Copy link
Member

/cc @sbesson

@sbesson
Copy link
Member

sbesson commented May 1, 2013

@joshmoore: although I like the idea of hosting images on necromancer and not have them under version control, I tried the following test:

.. figure:: http://www.openmicroscopy.org/site/products/omero/omero/FeatureIcons/group_orange48.png

When compiling the HTML with the default Jenkins options SPHINXOPTS=-W -D html_theme=plonematch, I get the following error:

/Users/sebastien/code/openmicroscopy/docs/sphinx/formats/developers/roi.txt:None: WARNING: nonlocal image URI found: http://www.openmicroscopy.org/site/products/omero/omero/FeatureIcons/group_orange48.png

If no -W is passed, the HTML builds fine and the image is embedded. The PDF does not work at all though.
If you wanted to implement this change right now, we would have to disable the -W option all across the jobs and have a broken PDF. Looks like a regression to me.

Two potential solutions I can think of if we want to host images on necromancer would be:

  • create a target to download the images locally and exclude images/ from revision control e.g. make sync-images && make clean html latexpdf
  • create a custom remote-image role that would not throw a warning in the HTML, check the link and download the image for PDF generation and then use: ``:remote-image:http://www.openmicroscopy.org/site/products/omero/omero/FeatureIcons/group_orange48.png

See also this thread

@gusferguson
Copy link
Author

The images (and the rest of my docs) are just backed up on squig at the moment.

@joshmoore
Copy link
Member

I like either of your suggestions, but I was definitely thinking more of the former, in which when building on necromancer, the files would just be in the "right place".

@joshmoore
Copy link
Member

Note: ongoing discussion in google doc on how best to address this.

@gusferguson
Copy link
Author

@hflynn
Copy link
Member

hflynn commented Jun 3, 2013

Decision has been made to hold off moving images until after Paris so we don't risk breaking things or make ourselves any busier than we are already. Can we get this merged then please so @gusferguson doesn't have a big backlog of version differences to deal with?

@joshmoore
Copy link
Member

Understood. Merging.

joshmoore added a commit that referenced this pull request Jun 3, 2013
@joshmoore joshmoore merged commit 6835872 into ome:dev_4_4 Jun 3, 2013
@jburel
Copy link
Member

jburel commented Sep 9, 2013

--no-rebase

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

Successfully merging this pull request may close these issues.

None yet

5 participants