monero-ecosystem / monero-gui-guide Goto Github PK

Once the guide will be ready, this repository need to be set up to accept translations

I thought it was best to start an issue to continue discussion from #4. There's no reason to hold up that PR on this.

Here's what I've been working on for binary verification documentation: https://github.com/qubenix/monero-documentation/blob/qubenix-verify1/binary-verification.md. I tried to keep is as short as possible. I still think it's best to have this as its own guide and just link to it from the GUI guide.

I used the verification documentation from various security focused projects as inspiration, trying to keep it as short and simple as possible.

https://www.whonix.org/wiki/Whonix_Signing_Key
https://www.whonix.org/wiki/VirtualBox/Verify_the_virtual_machine_images_using_the_command_line
https://wiki.archlinux.org/index.php/Category:Getting_and_installing_Arch
https://www.qubes-os.org/security/verifying-signatures/
https://www.torproject.org/docs/verifying-signatures
https://tails.boum.org/install/download/
https://gnupg.org/download/integrity_check.html

The formatting for ordered instructions in the text, and when referencing certain numbered areas of an image, do not use markdown's ordered list formatting. Using it will allow for a better layout by pandoc when generating the various formats, and better control of how they look with CSS/LaTex.

Was there a decision not to use ordered lists?

See monero-project/monero-gui#1275

Text and Screenshot

https://monero.stackexchange.com/questions/9901/how-do-i-generate-a-ledger-monero-wallet-with-the-gui-monero-wallet-gui

after monero-project/monero-gui#1368 will be merged

Screenshot and description
monero-project/monero-gui#1826

monero-project/monero-gui#1858

Add screenshot of 'Layout section'
monero-project/monero-gui#1802

so that the name of the resulting PDF will just be monero-GUI-guide.pdf with no version number

The format of the PDFs, using pandoc, is always a bit broken, this would be solved by using a template, as suggested from @pazos in #23 (comment)

Maybe we could use the template suggested: https://github.com/evangoer/pandoc-ebook-template

The button will be hidden if it's not possible to scan a QR code

introduced by monero-project/monero-gui#1708

When building in Pandoc to PDF (the only one I've tried until now) and to Spanish, there are some words that aren't translated to Spanish by default and it seems to be a thing build in Pandoc.

Those words are:

#Contents: it should be translated to Contenido in Spanish and to other word for other languages.
#Chapters: the chapters of the guide. It appears at the beginning of every chapter.
#Figure: often used as image but still not translated. It appears below any image included in the guide.

Those are the words I noticed, and yes, of course it can be left that way and won't be a problem because many people are bilingual but to make a complete and more professional translation it must be correct to have everything correctly translated.

This will happen too for other languages, at least it's something we can predict but I'm not 100% sure.

as suggested here.

Right now the section 6 it's obsolete and section 8.1 is missing. See #55 (comment)

Link to guides: 'View Only', 'Restore from keyx', 'Prove payment' and 'Restore account' on getmonero.org once monero-project/monero-site#736 is merged

@qubenix can you upload the XCF file of the numbers we used on the pictures insithe the media folder (maybe in a subfolder called _numbers or something like that)? I don't have them but they will be needed. The screenshots will need to be in the translated language as well

Will do it after the 1.1 release of this guide

They are too big and they also mess up the format of the PDF.
A reduction of 30-35% should be enough.

ref: monero-project/monero-site/#649

monero-project/monero-gui#1706

monero-project/monero-gui#1793

'Receive' section needs to be completely redone

Added with #57.Since that issue will be fixed

On windows/linux
(ctrl+tab) -> go to the next page
(ctrl + shift + tab) ->go to the previous page

On osx:
(cmd+tab) -> go to the next page
(cmd + shift + tab) ->go to the previous page

For all OSes:

Press Ctrl to view each page shortcut. Press (ctrl+"shorcut") to go to that page

Working on this today.

Update new screenshots according to monero-project/monero-gui#1511

As this comment explains

To be added in the "Common issues and solutions" section (?)

Referring: https://www.reddit.com/r/Monero/comments/8vr4nu/ledger_gui_guides_requires_gui_v01220/

Just a little typo at the end of ch02.md.
Greetings.

hrumag

After monero-project/monero-gui#1359 get merged we need to update the 'receive' page with a new picture

monero-project/monero-gui#1498

Adding dEBRUYNE's guide: https://monero.stackexchange.com/questions/10798/my-antivirus-av-software-blocks-quarantines-the-monero-gui-wallet-is-there/

Remove string (6) Privacy level (ringsize):, since ringsize is now fixed, and update screenshot

That squared flag of Turkey is so annoying. i can't update it since the resolution of my screen is too low and the picture will result splitted

monero-project/monero-gui#1855

to be up to date with #47 and monero-project/monero-gui#1452

referring monero-project/monero-gui#1496

The section has been renamed, but the old one was included in 0.13.0.3 and .4
That's why the label 'master'. Will remove it after next release of this guide, when i will start to use branches for releases

In progress by @hrumag

https://taiga.getmonero.org/project/erciccione-monero-localization/task/426

After #76 the four spaces are not necessary and cause the resulting built markdown file showing \ at the end of every point of the list

TODO list:

• Resize pictures
• Update pictures with corrent version of the GUI
• Fix enumeration

The tab page of the new version of the payment, why is there no payment id?

with new picture and text. Help wanted at least for the picture

In ch02.md, LN4, the text is about 3 methods and 2 network options.
This was true before Hardware wallet support & Stagenet, but now it should respectively be 4 and 3.