Opened 4 years ago

Closed 4 years ago

#3427 closed undecided (fixed)

remove Adobe Illustrator version of images in docs

Reported by: rutsky Owned by: rutsky
Priority: minor Milestone: 0.9.0
Version: master Keywords:
Cc:

Description

I think .ai files are actual sources of images, e.g. https://github.com/buildbot/buildbot/blob/master/master/docs/manual/_images/slaves.ai (they were probably drawn in Adobe Illustrator). Later .ai files were exported in svg and png formats and used in docs.

Now I need to edit one of the images and I think I can't do it using open source software (at least Inkscape can't export in .ai format).

I suggest to reexport .ai files to svg (Inkscape can import .ai), and remove .ai files at all. Dustin, what do you think?

This is related to issue #2340.

Change History (15)

comment:1 Changed 4 years ago by rutsky

  • Priority changed from major to minor

comment:2 Changed 4 years ago by dustin

Yes, please do

comment:3 Changed 4 years ago by adityadivekar

I have just started working on buildbot and would like to work on this issue.

I think that if we remove the command to include .ai images include docs/manual/_images/*.ai from the MANIFEST.in file, and then delete the .ai images, the fix could work because there is no explicit reference to the .ai files as such in the project. Thus not including them should automatically redirect to the use of .svg images. The command to include them is already present in the MANIFEST.in file.

I would like to know if this is the right approach.

comment:4 Changed 4 years ago by rutsky

@adityadivekar, thank you for enthusiasm!

However, this issue is part of #2340, and I would prefer to do this simple issue by myself, since I also need to edit those images.

comment:5 Changed 4 years ago by dustin

  • Owner set to rutsky
  • Status changed from new to assigned

Sorry, Aditya, for steering you wrong.

@rutsky, are there other small bugs that Aditya could get started with?

comment:6 Changed 4 years ago by rutsky

Out of issues that I reported recently this one is pretty easy: #3437.

#3415 is easy but requires knowledge how to catch output of test in Twisted's TestCase.

Aditya, if you are Windows user and familiar system stuff, perhaps #3405 would be easy to you.

If you would like to try web UI part of Buildbot, you can try #3423. It's easy, but it requires specific knowledge of AngularJS (in case you would like to learn it).

Dustin's #3435 should be easy too.

Last edited 4 years ago by rutsky (previous) (diff)

comment:7 Changed 4 years ago by rutsky

comment:8 Changed 4 years ago by dustin

I don't know -- hopefully git blame blames someone other than me? :)

comment:9 Changed 4 years ago by rutsky

Nope, it's you :)

comment:11 Changed 4 years ago by rutsky

Dustin, which docs version are currently build and should be actual?

I believe these PNG was for building PDF-book with Sphinx + Latex. Is this is still a use case for docs?

comment:12 Changed 4 years ago by rutsky

I reduced SVG image canvas size and regenerated PNGs — they now tightly cropped as should be according to Makefile.

comment:13 Changed 4 years ago by rutsky

Hm, ticket #2238 says, that its Read The Docs who tries to build PDF book. Do we use Read The Docs nowadays?

comment:14 Changed 4 years ago by dustin

http://docs.buildbot.net/ does link to a number of formats, but that was more "because they are there" than because someone needed them. So if we lost ePub I'm sure that would be OK, and I suspect PDF would be fine too.

comment:15 Changed 4 years ago by rutsky

  • Resolution set to fixed
  • Status changed from assigned to closed
Note: See TracTickets for help on using tickets.