Shoalsteed / UX

UX Overview March 5
0 stars 0 forks source link

Copy #25

Closed Shoalsteed closed 1 year ago

Shoalsteed commented 3 years ago

updating copy for download & Install process

Shoalsteed commented 3 years ago

The I2P Software ( learn More) https://geti2p.net/en/about/software

The I2P software includes everything you need to connect to the I2P network, as well as applications and configuration options for communicating and setting up your own services. Send mail, use the I2P bitorrent client, connect to irc, or create your own site or forum!

The I2P software includes: A router & router console: The I2P router will connect you to the network. This is similar to how a home router works. The router console provides access to your connection stats, router connection health, as well as a stop and start option. It includes a light and dark theme, and provides news about updates and quick access to your applications and settings.

SusiMail: SusiMail is a secure email client. It is primarily intended for use with Postman’s email servers inside of the I2P network . It is designed to avoid leaking information about email use to other networks. SusiMail is bridged so it can send and receive email from the internet as well. Occasionally you may see some services like Gmail classifying it as spam, which you can correct in your Internet email service providers settings.

I2PSnark: Snark is an I2P network only BitTorrent client. It never makes a connection to a peer over any other network.

The Address Book: This is a locally-defined list of human-readable addresses ( ie: i2p-projekt.i2p) and corresponding I2P addresses.(udhdrtrcetjm5sxzskjyr5ztpeszydbh4dpl3pl4utgqqw2v4jna.b32.i2p) It integrates with other applications to allow you to use those human-readable addresses in place of those I2P addresses. It is more similar to a hosts file or a contact list than a network database or a DNS service. There is no recognized global namespace, you decide what any given .i2p domain maps too in the end.

The QR Code Generator: Besides the Address Book, I2P addresses can be shared by converting them into QR codes and scanning them with a camera. This is especially useful for Android devices.

I2P Web Server:This is your own anonymous I2P webserver. Simply edit the files in the webserver's root directory and your site will be public once you follow the instructions included.

I2P Hidden Services Manager This is a general-purpose adapter for forwarding services ( ie SSH ) into I2P and proxying client requests to and from I2P. It provides a variety of “Tunnel Types” which are able to do advance filtering of traffic before it reaches I2P.

Should we include screenshots or illustrated screenshots or illustrations ( ie an envelope for mail?)

luciewho commented 3 years ago

To-do for Copy

Landing page: new CTA ("Get Started" "Install I2P") new secondary CTA ("Learn More" "What is I2P?")

New pages: Getting started page intro paragraph and cards/steps Learn More page - i2p software and network   Download page: Steps 1-2-3 cards Clearer description on mirror pages

Installation guide page: Instructional steps for each OS   Config page: Instructional steps for each browser

Shoalsteed commented 3 years ago

Java Instructions that can be used for all OS options except Debian, Ubuntu and Android

Install Java: I2P is written in Java and requires that Java be installed to run. In addition to the I2P download, you need to install Java if you do not have it already installed. I2P requires Java Runtime Version 7 or higher. (Oracle, OpenJDK, or IcedTea Java Version 7 or 8 recommended, except Raspberry Pi: OpenJDK 9 for ARM, PowerPC: IBM Java SE 7 or 8) Determine your installed Java version here or type java -version at your command prompt. Only two platforms do not require Java to be installed before I2P is installed, those platforms are Android and Debian and Ubuntu.

Shoalsteed commented 3 years ago

Install I2P: Once you have Java installed, you can install the I2P software. This is a 2 step process that includes the actual install process as well as a set up wizard.

Shoalsteed commented 3 years ago

Browser Configuration Your web browser will need to be configured in order to browse web sites on I2P and to utilize the outproxies available within I2P. Walkthroughs are available for most browsers.

Shoalsteed commented 3 years ago

CTA The Invisible Internet is a privacy by design, people-powered network. It is a truly free and anonymizing Internet alternative.

New Option: An anonymizing peer to peer internet alternative

Shoalsteed commented 3 years ago

Getting Started with I2P

The Invisible Internet Project (I2P) is a fully encrypted private network layer. The network protects your activity and location. Additionally, I2P has created transport protocols that resist DPI censorship.

I2P is a peer-to-peer network. Peers make a portion of their resources, particularly bandwidth, available to other network participants. This allows the network to function with relying on centralized servers.

I2P has an application layer with easy to use APIs for creating your own privacy - aware apps.

Basic Steps 1 Download I2P needs Java to run for Windows, Mac, and Linux. Download Java here.

2 Installation Step-by-step installation guides include setting up Java, installing I2P and using the I2P set-up wizard.

3 Configuration Configure your browser settings to be compatible with the I2P network. Download I2P Install Configure

luciewho commented 3 years ago

Java Instructions that can be used for all OS options except Debian, Ubuntu and Android

Install Java: I2P is written in Java and requires that Java be installed to run. In addition to the I2P download, you need to install Java if you do not have it already installed. I2P requires Java Runtime Version 7 or higher. (Oracle, OpenJDK, or IcedTea Java Version 7 or 8 recommended, except Raspberry Pi: OpenJDK 9 for ARM, PowerPC: IBM Java SE 7 or 8) Determine your installed Java version here or type java -version at your command prompt. Only three platforms do not require Java to be installed before I2P is installed, those platforms are Android and Debian and Ubuntu.

The last sentence says "two platforms" but mentions Android, Debian, and Ubuntu. Is that 3 then? Or do Debian and Ubuntu go together under Linux?

luciewho commented 3 years ago

Getting Started with I2P

The Invisible Internet Project (I2P) is a fully encrypted private network layer. The network protects your activity and location. Additionally, I2P has created transport protocols that resist DPI censorship.

I2P is a peer-to-peer network. Peers make a portion of their resources, particularly bandwidth, available to other network participants. This allows the network to function with relying on centralized servers.

I2P has an application layer with easy to use APIs for creating your own privacy - aware apps.

Basic Steps 1 Download I2P needs Java to run for Windows, Mac, and Linux. Download Java here.

2 Installation Step-by-step installation guides include setting up Java, installing I2P and using the I2P set-up wizard.

3 Configuration Configure your browser settings to be compatible with the I2P network. Download I2P Install Configure

For Step 1, I think it needs to have something in there about downloading I2P rather than just Java, because the Getting Started page is meant as an overview for all OS types.

The boxes look like this as well, so there's room for more copy. But if there isn't that much copy, then the boxes should be smaller.

Screen Shot 2021-08-19 at 7 10 22 AM

For the intro section above the steps, I tacked on a "Learn more about I2P" link at the end. I also added a System Requirements section that mentions the Java requirement. I could use the copy above for "Install Java" instead?

Screen Shot 2021-08-19 at 7 11 58 AM
Shoalsteed commented 3 years ago

Java Instructions that can be used for all OS options except Debian, Ubuntu and Android Install Java: I2P is written in Java and requires that Java be installed to run. In addition to the I2P download, you need to install Java if you do not have it already installed. I2P requires Java Runtime Version 7 or higher. (Oracle, OpenJDK, or IcedTea Java Version 7 or 8 recommended, except Raspberry Pi: OpenJDK 9 for ARM, PowerPC: IBM Java SE 7 or 8) Determine your installed Java version here or type java -version at your command prompt. Only three platforms do not require Java to be installed before I2P is installed, those platforms are Android and Debian and Ubuntu.

The last sentence says "two platforms" but mentions Android, Debian, and Ubuntu. Is that 3 then? Or do Debian and Ubuntu go together under Linux?

i simply copied an existing typo- three.

Shoalsteed commented 3 years ago

regarding tacking on the Learn more about i2p - do we want to interrupt the download and install workflow when this information is going to be available on the landing page?

luciewho commented 3 years ago

The basic steps under download page for Mac look like this

Screen Shot 2021-08-19 at 8 46 50 AM

But the other OS like Android and Docker won't need step 1 (Java). It could have different copy or just remove that card and have only 2 cards.

Shoalsteed commented 3 years ago

The basic steps under download page for Mac look like this

Screen Shot 2021-08-19 at 8 46 50 AM

But the other OS like Android and Docker won't need step 1 (Java). It could have different copy or just remove that card and have only 2 cards.

I think we can add the preamble ie: I2P is available in the official repositories for Ubuntu Bionic and later, and Debian Buster and Sid. However, Debian Buster and Ubuntu Bionic (LTS) distributions will have older I2P versions. If you are not running Debian Sid or the latest Ubuntu release, use our Debian repo or Launchpad PPA to ensure you're running the latest I2P version. where the java box would go.

luciewho commented 3 years ago

regarding tacking on the Learn more about i2p - do we want to interrupt the download and install workflow when this information is going to be available on the landing page?

I would think most users would click it as a new tab or use the back button to return to the getting started page. I figured it would be good to have a way to read more as they scan that page. But I think not interrupting the flow and moving them along to download makes sense too.

I can try to test it in a usability test and see what users prefer.

luciewho commented 3 years ago

The basic steps under download page for Mac look like this

Screen Shot 2021-08-19 at 8 46 50 AM

But the other OS like Android and Docker won't need step 1 (Java). It could have different copy or just remove that card and have only 2 cards.

I think we can add the preamble ie: I2P is available in the official repositories for Ubuntu Bionic and later, and Debian Buster and Sid. However, Debian Buster and Ubuntu Bionic (LTS) distributions will have older I2P versions. If you are not running Debian Sid or the latest Ubuntu release, use our Debian repo or Launchpad PPA to ensure you're running the latest I2P version. where the java box would go.

Sounds good. The copy might need to be cut down to fit into that box. Or the boxes/basic steps can have a slightly different look for Android/Linux. I'll work on that when I make wireframes for other OS.

luciewho commented 2 years ago

I highlighted the copy that needs to be looked over in red.

Taglines on the Tech Docs Copy for the single pages in Tech Docs. Attached is the Overview batch of pages.

Screen Shot 2021-09-08 at 2 10 42 PM

Docs - Overview.pdf

luciewho commented 2 years ago

I want to talk about the hierarchy and titling of the pages. There is some inconsistency in how the pages are presented, which I think will affect the copy and how it will be organized.

The page title is at the top right on the main menu (should be moved to inside the actual page itself since the new main menu links will be there).

Some of the section headers are centered like this:

Screen Shot 2021-09-08 at 2 29 35 PM

Centered section headers with sub-headers left aligned with a line underneath:

Screen Shot 2021-09-08 at 2 31 02 PM

On other pages, the section header is left aligned with a line and sub-headers left aligned no line:

Screen Shot 2021-09-08 at 2 32 12 PM
Shoalsteed commented 2 years ago

i wonder if this is just a css fix?

luciewho commented 2 years ago

Yeah I think it will just involve CSS.

I think all the headers should be left-aligned along with the Page Title. There can be a different color or font for the page title for distinction. And keeping the line under the header helps provide more organizational clarity and distinguishes it from the sub-header.

luciewho commented 2 years ago

Example of page hierarchy

Screen Shot 2021-09-09 at 12 32 39 PM

Shoalsteed commented 2 years ago

Research Section Copy (Taglines)

Academic Research General safety guidelines for research ethics and testing the network

Academic Papers and Peer Review Known published papers written about the I2P network

Open research topics  A list of open questions for research

I2P Metrics  I2P Metrics collects and analyzes historical infrastructure data from the I2P network

Vulnerability Response Contact, response and disclosure process

Shoalsteed commented 2 years ago

App Development Overview and Guide Start writing I2P Specific Applications

Other Router Topics Software updates, reseeds, GeoIP and configuration file specifications.

luciewho commented 2 years ago

Awesome, got all the taglines into Docs!

luciewho commented 2 years ago

@Shoalsteed Do you have a recommendation for how the copy for Tool Tip could be revised?

Screen Shot 2021-09-25 at 11 20 44 AM

luciewho commented 2 years ago

Red text - some other way of explaining this more eloquently?

Screen Shot 2021-09-26 at 12 06 23 PM

luciewho commented 2 years ago

Screen Shot 2021-10-11 at 5 58 40 PM

Shoalsteed commented 2 years ago

Regarding Ubuntu - lets get IDK to sort that out.

Shoalsteed commented 2 years ago

LS2

ls2 meetings, Mondays 6:30 PM UTC, IRC #ls2

For development conversations about I2P network performance and security. Past Topics http://i2pforum.net/viewforum.php?f=13&sid=993d32890ddbe5b00ab242c386d4a78f I2P Proposals https://geti2p.net/spec/proposals

Shoalsteed commented 2 years ago

I2P Developer Meetings Project meetings are held on the first Tuesday of every month at 8 PM UTC. If you have something to discuss, please find the developers on IRC in #i2p-dev The current roadmap can be viewed here https://geti2p.net/en/get-involved/roadmap

Shoalsteed commented 2 years ago

I2P Usability Lab The I2P Usability Lab will announce monthly Discord meetups. Join us for conversations about our research, and open panel talks with the community.

Shoalsteed commented 2 years ago

@Shoalsteed Do you have a recommendation for how the copy for Tool Tip could be revised?

Screen Shot 2021-09-25 at 11 20 44 AM

"Firefox will provide a Proceed with caution warning when accessing and changing configuration options. You will need to choose Accept the Risk and Continue"

luciewho commented 2 years ago

Here's what is looks like with the new copy on the Events page.

I'm not sure about where to put the hashtags #ls2? Does this look right? Is there a unique description to use for the I2P Developer Meeting? I just copied what was written for LS2. For I2P Usability Lab, there isn't a time/day set quite yet, so just link to the Discord? Is "Join Meeting on IRC" okay for LS2 and Developer meetings?

Screen Shot 2021-10-15 at 12 15 12 PM
Shoalsteed commented 2 years ago

I2P Developer Meetings Monthly community meetings and updates from developers on current roadmap status. Project meetings are held on the first Tuesday of every month at 8 PM UTC. If you have something to discuss, please find the developers on IRC in #i2p-dev The current roadmap can be viewed here https://geti2p.net/en/get-involved/roadmap

luciewho commented 2 years ago

Is there a link for this IRC? "please find the developers on IRC in #i2p-dev
" And links for the "Join Meeting on IRC" and "Join the Discord"

Shoalsteed commented 2 years ago

Screen Shot 2021-10-15 at 3 19 33 PM

I would make the invite look like this - and where you have Join the meeting , put the irc direction there ( #i2p-dev or Ls2 )

Shoalsteed commented 2 years ago

Is there a link for this IRC? "please find the developers on IRC in #i2p-dev
" And links for the "Join Meeting on IRC" and "Join the Discord"

No links, as far as I know! Can confirm with IDK if creating a link is possible for irc.

luciewho commented 2 years ago

Oo I see. I'm not familiar with IRC. I'll make a note to ask idk, thanks!

luciewho commented 2 years ago

How the page looks currently (URLs for the links in purple text are noted on the side of the wireframe - not seen)

Screen Shot 2021-10-15 at 12 33 20 PM
luciewho commented 2 years ago

Need copy for the tagline for the Presentations, Tutorials, Articles card (text in pink) in the Research page

Screen Shot 2021-11-06 at 9 37 31 PM Screen Shot 2021-11-06 at 9 37 39 PM
luciewho commented 2 years ago

Revise this copy (in pink)? Something I wrote on the spot. Not sure what to call it but I wrote "Old Download Page" as a placeholder. Non-jpackage download process.

Screen Shot 2021-11-06 at 9 39 46 PM Screen Shot 2021-11-06 at 9 40 03 PM
Shoalsteed commented 2 years ago

Need copy for the tagline for the Presentations, Tutorials, Articles card (text in pink) in the Research page

Screen Shot 2021-11-06 at 9 37 31 PM Screen Shot 2021-11-06 at 9 37 39 PM

Maybe we should rename this "Additional Resources" Copy: Articles and Presentations about the I2P network

**remove Tutorials since that is software specific

Shoalsteed commented 2 years ago

Revise this copy (in pink)? Something I wrote on the spot. Not sure what to call it but I wrote "Old Download Page" as a placeholder. Non-jpackage download process.

Screen Shot 2021-11-06 at 9 39 46 PM Screen Shot 2021-11-06 at 9 40 03 PM

I2P Java developers For people who are Java developers, we suggest downloading the full Java software. *** ask Idk about wording here

luciewho commented 2 years ago

Finesse the copy in pink.

Screen Shot 2021-11-21 at 11 03 29 AM
luciewho commented 2 years ago

Revise the copy in the hero image to be more like everyday language, cut down the jargon even more or entirely. Example of new copy in second image.

Screen Shot 2021-11-21 at 11 04 07 AM Screen Shot 2021-11-21 at 11 04 19 AM

We are building a private and anonymizing network. A place to gather, create and explore without giving up your data and identity.??

luciewho commented 2 years ago

New tagline for Tutorials

Screen Shot 2021-11-22 at 10 06 01 AM

Guides For Developer, Service Operators and Admins??

luciewho commented 2 years ago

Let's put these in order of priority. Copy revision pages: translation, reseed, intro, tech intro, glossary, get involved, software licenses, dev guidelines, roadmap, FAQ reorg, donate, contact

  1. Intro
  2. Tech Intro
  3. FAQ (may tie into pages that need to be created)
  4. Glossary
  5. Get Involved
  6. Translation
  7. Software Licenses
  8. Dev Guidelines
  9. Donate
  10. Contact
  11. Roadmap (based on idk)
Shoalsteed commented 2 years ago

Finesse the copy in pink.

Screen Shot 2021-11-21 at 11 03 29 AM

https://github.com/Shoalsteed/I2P-Secure-Design-Collective/issues/86

https://www.gnu.org/philosophy/free-sw.html

luciewho commented 2 years ago

https://geti2p.net/en/get-involved/guides/dev-guidelines

Report Bugs needs to be changed to Issues. Copy in the paragraphs updated.

"trac needs to be replaced with Git issues, go through and make sure that any new or missing ways for how to contribute using Git is available and updated."

Shoalsteed commented 2 years ago

https://geti2p.net/en/get-involved/guides/dev-guidelines

Report Bugs needs to be changed to Issues. Copy in the paragraphs updated.

"trac needs to be replaced with Git issues, go through and make sure that any new or missing ways for how to contribute using Git is available and updated."

https://github.com/Shoalsteed/UX/issues/59 updated