×

Notice

The forum is in read only mode.
  1. Forum
  3. Development
  5. Development
  7. Updating and internationalizing documentation

Updating and internationalizing documentation

More
18 Mar 2017 18:51 #60341 by Moeder
Updating and internationalizing documentation was created by Moeder
Since we have the complete documentation in a github repository and FDR is already working on automated building in Travis, what do you think of moving things around and in the repository and set up directories for multiple languages similar to this ?
Once done, we could invite more users who are willing to work on translations of the manual (for example Morlacus offered to spent time on a French version).
More
18 Mar 2017 20:27 #60348 by FDR
Replied by FDR on topic Updating and internationalizing documentation
I'm stucked with Travis.
It couldn't compile the documentation just like either of my two docker environments can't do that...
More
19 Mar 2017 23:18 - 20 Mar 2017 00:19 #60387 by Moeder
Replied by Moeder on topic Updating and internationalizing documentation
Travis is running really smooth, but trying to get deviation-manual build in the docker image has been driving me nuts for the last couple of hours ....


edit: somehow python in my debian VM is totally messed up. Installed a fresh Ubuntu 16.10 VM and installed pip using the official install-script get-pip.py and everything is compiling smoothly :silly:
Last edit: 20 Mar 2017 00:19 by Moeder.
More
23 Mar 2017 14:18 #60617 by mwm
Replied by mwm on topic Move docs into the main repository?
While you're reworking the docs, I'd like to suggest that they be moved into the source repository, though in a different directory.

The reason for this is to tweak the process of updating a release. You'd move things (like protocols) into the release branch only when the documentation is also in place so you can move it all at once. It would also make it easier to maintain proper documentation on multiple versions of the firmware.
Do not ask me questions via PM. Ask in the forums, where I'll answer if I can.

My remotely piloted vehicle ("drone") is a yacht.
More
26 Mar 2017 20:12 #60779 by FDR
Replied by FDR on topic Updating and internationalizing documentation
How do you include the env/matrix variables into script parameters?
More
26 Mar 2017 20:23 #60781 by Moeder
Replied by Moeder on topic Updating and internationalizing documentation
I don't quite understand. Do you mean Travis. Yml? They should be accessible as shell variables ($xyz).
More
26 Mar 2017 20:27 #60782 by FDR
Replied by FDR on topic Updating and internationalizing documentation
Yes, I want to include the TARGET=devoXX in the script portion of the .travis.yml, because I think it doesn't get it.
So if I change it to:
script:
    - make html pdf $TARGET
...then will it receive "TARGET=devo10" or only "devo10"?
More
27 Mar 2017 05:50 #60790 by Moeder
Replied by Moeder on topic Updating and internationalizing documentation
TARGET gets set correctly, Travis logs show the matrix built correctly. Your TARGET_VERSION variable is not found
More
28 Mar 2017 05:38 #60835 by Moeder
Replied by Moeder on topic Updating and internationalizing documentation
I fixed the after_success part, but the decrypt of install_documentation is not working yet. I cannot solve this for you :)
More
28 Mar 2017 06:08 #60836 by FDR
Replied by FDR on topic Updating and internationalizing documentation
Yes, I know, I'm on it.
So far if I encrypt a file, and then decrypt it on my PC it can't decrypt either.
They wrote about OpenSSL, that it has problems on Windows, but I did it in the MinGW window.
Next I will try it in the docker...
More
28 Mar 2017 19:29 #60869 by Moeder
Replied by Moeder on topic Updating and internationalizing documentation
I did a quick test with travis and my github fork - please read your PM
More
28 Mar 2017 20:09 #60871 by FDR
Replied by FDR on topic Updating and internationalizing documentation
I think it is not about Travis anymore.
I can't even decrypt any file which I previously encrypted with openssl, despite I use the same proper key pair...

And since I read somewhere that OpenSSL has problems on Windows, I have tried it in the MinGW window, in the docker shell, and even on Google Could Platform with the same result, so I think I must be doing something wrong.
I have even tried with a magic word instead of the key pair (actually key + iv)...

I will try some other encryptions, or sooner or later I should read the openssl documentation... ;)
More
28 Mar 2017 20:11 #60872 by Moeder
Replied by Moeder on topic Updating and internationalizing documentation
You don't need to use openssl by hand, the travis command line interface does it all for you! See my private message.
More
28 Mar 2017 20:41 #60875 by FDR
Replied by FDR on topic Updating and internationalizing documentation
F..K!!!!@&ßä*-%"+!! :evil: :evil: :evil: :evil: :evil: :evil: :evil:

I've found the mistake I made as soon as I wrote it down to you to try!
So, I think I'm back on track again...
More
28 Mar 2017 20:56 #60876 by Moeder
Replied by Moeder on topic Updating and internationalizing documentation
:lol:
Ok, small option - big meaning ;)

We'll figure out the rest eventually...
More
28 Mar 2017 21:13 #60878 by FDR
Replied by FDR on topic Updating and internationalizing documentation
Yes, and I copied and copied and copied again and again... :blush:

So now it decrypts well, but don't expect too much, because it is only a first test.
Only the PDFs are uploaded, and even those into a different directory...
While the upload was successful, the addition to the downloads has failed, probably because there are already existing downloads with the same name...

I will continue tomorrow.
Thanks!
More
29 Mar 2017 04:55 - 29 Mar 2017 04:56 #60885 by Moeder
Replied by Moeder on topic Updating and internationalizing documentation
I know how you feel ;)
Actually there is an error in the script or one of the parameters thrown to it.. Maybe some wrong parentheses again.
$ utils/upload_documentation.pl -skip -documentation build/pdf-$TARGET/$TARGET_PDF -pdf build/pdf-$TARGET/$TARGET_PDF
Unknown option: skip
/usr/bin/curl
Logging in as NightlyBuilds
Logged in
ERROR: Can't read build/pdf-devo8/echo
Last edit: 29 Mar 2017 04:56 by Moeder.
More
29 Mar 2017 05:46 #60887 by FDR
Replied by FDR on topic Updating and internationalizing documentation
Nevermind the skip parameter, it doesn't have any meaning here, but of course I will correct it.
We still have proglems with the TARGET_PDF though...
More
29 Mar 2017 13:32 #60903 by Moeder
Replied by Moeder on topic Updating and internationalizing documentation
It seems like it is working now. Where can the manual pdf be found?
More
29 Mar 2017 13:47 #60904 by FDR
Replied by FDR on topic Updating and internationalizing documentation
No, not yet, it just doesn't give errors anymore.
I've said, that it's just a first draft, which so far copies only the PDFs into a separate directory, and tries to register them into the download section, but even that hasn't yet succeeded.
It still needs quite a few modification from my part, but all the needed steps are working, at least in theory...
  1. Forum
  3. Development
  5. Development
  7. Updating and internationalizing documentation
Time to create page: 0.201 seconds
Powered by Kunena Forum
Force desktop display