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

feat: update welcome page content #884

Merged
merged 24 commits into from
May 27, 2020
Merged

feat: update welcome page content #884

merged 24 commits into from
May 27, 2020

Conversation

jessicaschilling
Copy link
Contributor

@jessicaschilling jessicaschilling commented May 19, 2020

Updates welcome page content to improve usefulness of right-pane resources and clarity of left-pane messaging. Plus some visual tweaks.

  • Left-pane (node-on state): standardizes check icon to ipfs-css
  • Left-pane (node-on): Increases prominence of peer connection message
  • Left-pane (node-on): adds buttons for files and peers, renames generic "Web UI" button to "Status"
  • Left-pane (node-off): Adds ipfs-css caution icon for consistency
  • Left-pane (node-off): Clarifies next steps for IPFS desktop and CLI users; checks links
  • Right-pane: Rewords resources as bullets in a more topical format, and adds newly improved resources
  • Right-pane: Updates both videos to more recent content

Still to do (requesting help from @lidel or @rafaelramalho19 if possible!):

  • Make cube logo in pop-up a link to the welcome page
  • Send left-pane (node-on state) buttons for files and peers to the appropriate screens in Web UI - right now they just go to Web UI status page

Note! Links to docs won't work until after docs beta migration is complete -- right now this is slated for 27 May.

Closes #818.

Copy link
Member

@lidel lidel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jessicaschilling this is great! I know its still early wip, but two thoughts:

add-on/_locales/en/messages.json Outdated Show resolved Hide resolved
add-on/src/landing-pages/welcome/page.js Outdated Show resolved Hide resolved
@jessicaschilling jessicaschilling changed the title WIP: Update welcome page content Update welcome page content May 20, 2020
@jessicaschilling
Copy link
Contributor Author

jessicaschilling commented May 20, 2020

Hi @lidel -- hopefully this is in a less messy state for your persual. Content is in a better place, but I'm still having trouble making the cube logo in the pop-up clickable, and directing the two new buttons to the correct locations. If you're able to point me in the right direction, much appreciated!

This won't be worth merging until IPFS docs site is fully migrated (so far that's 27 May), so please take your time 😊

Thank you very much!

@lidel
Copy link
Member

lidel commented May 27, 2020

Looking 👀

lidel added 2 commits May 27, 2020 16:34
Adds page parameter to the openWebUi event, enabling us to open
ipfs-webui on arbitrary pages.
Clicking on the cube opens Welcome screen, which was displayed only
oninstall before.
Copy link
Member

@lidel lidel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This packs a lot of improvement, excited for shipping this as soon docs website is ready!

  • I've wired up Status, Files and Peers buttons on Welcome page and made it easier to do it in the future by passing page name we want to open.
  • As suggested, also made the cube in browser action menu open Welcome page.

On add-on/_locales

I've seen you took time to update locales other than en - if you did that to see how other languages look like, thats fine, but if you did that just for completeness, no need to do it: tx pull -a will override translations anyway, and will update changed keys when needed, so you can save some time by ignoring locales other than en in the future.

(any missing keys will be automatically filled with labels from en version at a runtime, so it is safe to leave old key names)

add-on/_locales/en/messages.json Outdated Show resolved Hide resolved
@jessicaschilling
Copy link
Contributor Author

@lidel Thank you for the localization feedback, and for adding the clickable elements! 🙏 Made those minor changes.

@jessicaschilling
Copy link
Contributor Author

Just confirmed by clicking from my local install - the docs links all go to the correct New Docs pages. I think we're good to proceed!

@jessicaschilling jessicaschilling removed the request for review from lidel May 27, 2020 19:04
@jessicaschilling
Copy link
Contributor Author

(ETA: Quick change to button translation strings. I'll re-request review in a few.)

@jessicaschilling
Copy link
Contributor Author

jessicaschilling commented May 27, 2020

@lidel I think we're finally good on this one, pending checks passing. Re-requesting your review ... please merge if you're happy. Thank you!

Copy link
Member

@lidel lidel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks again!

(I'll wait till Friday with releasing this to Beta, to give Transifex time to update)

"description": "Install steps title (page_landingWelcome_installSteps_cli_title)"
},
"page_landingWelcome_installSteps_cli_install": {
"message": "Follow <0>these instructions</0>, then start an IPFS daemon in your terminal:",
"message": "Start IPFS by entering <code class=\"yellow\">ipfs daemon</code> in your terminal. If you don't have IPFS installed yet, follow the <0>CLI quick-start guide</0> first.",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to self: I believe Transifex UI is now collapsing HTML tags making them non-editable, so this should be fine. If causes trouble, we'll fix in a separate PR.

Copy link
Member

@lidel lidel May 28, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jessicaschilling @rafaelramalho19 FYI I just confirmed that Transifex handles such simple inlined HTML tags pretty well. They blackbox the tag, ensuring translator can't break the markup – could be useful in the future, if needed:

Screenshot_2020-05-29 IPFS Companion Transifex Editor(1)

@lidel lidel changed the title Update welcome page content feat: update welcome page content May 27, 2020
@lidel lidel merged commit 053cc70 into master May 27, 2020
@lidel lidel deleted the feat-welcomepage-update branch May 27, 2020 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Welcome Page
2 participants