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: make Preferences link to docs site #871

Merged
merged 14 commits into from
May 10, 2020
Merged

feat: make Preferences link to docs site #871

merged 14 commits into from
May 10, 2020

Conversation

jessicaschilling
Copy link
Contributor

@jessicaschilling jessicaschilling commented Apr 24, 2020

  • Moves privacy-policy.md and examples directory to top level; fixes links to privacy policy that result from the move
  • Removes docs directory; all the remaining content has been moved to docs beta per Migrate Companion docs ipfs-docs#182
  • Updates all "Read more" links in Companion prefs to point to the appropriate pages on docs-beta.ipfs.io
    • NOTE: These URLs need to be changed once the docs legacy site is deprecated! But, the deprecation plan does include searching all IPFS codebases for instances of "docs-beta" and fixing. Plus redirects.

Closes #595 BUT shouldn't be merged until ipfs/ipfs-docs#182 is merged and docs are in place on the docs site.

One additional note: The "Load websites from custom gateway" option still points to #667 for its "Learn more" link. @lidel, are you up for writing a brief explainer to put in the docs once that issue is closed (presumably 0.5 release)?

@jessicaschilling jessicaschilling changed the title [WIP] Move "Read more" links in preferences to docs site Move "Read more" links in preferences to docs site Apr 24, 2020
@jessicaschilling
Copy link
Contributor Author

@lidel, for your reviewing pleasure!

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.

Thank you @jessicaschilling!
I will circle back to this docs migration before next release of ipfs-companion.

Note to self:

  • revisit which docs are dev-only and should be moved back
  • update link to privacy policy at Chrome Web Store when this is merged.

@lidel
Copy link
Member

lidel commented May 8, 2020

  • Capitalized .md files in the main directory for better discoverability
  • Restored developer-notes.md (merged android notes there) and localization-notes.md
    Those things are not useful to regular users, probably will just confuse them, I believe those docs should stay in this repo (see fix: remove dev docs from IPFS Companion section ipfs-docs#203)

@jessicaschilling does this sound ok?

@jessicaschilling
Copy link
Contributor Author

@lidel -- good idea on capitalization, thanks.
I'd copy-edited all materials brought over to the docs site, so ported those edits back here. Also replaced gifs directory. Please review as you're able -- thank you!

lidel added 4 commits May 9, 2020 23:02
We need this so users of older versions of ipfs-companion won't see "not
found" error.
this needs to happen when we restore injection of window.ipfs
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 thank you so much for tackling this!
(I am sorry I was slow to review, that produced some unnecessary back and forth)

I made small changes:

  • removed .gif images (loading them from IPFS instead: c3256a4)
  • restored .md used by older versions of IPFS Companion (ab90b04): I've put a link to article at docs portal in each, so user will get to the right place eventually (we can remove docs/ next quarter)
  • swapped link to the closed issue you mentioned with link to subdomain docs, as those provide information why Origin isolation provided by subdomain gateway is important (5cc608e)

I'm merging this to rebase and unblock #879

@lidel lidel changed the title Move "Read more" links in preferences to docs site feat: make Preferences link to docs site May 10, 2020
@lidel lidel merged commit eda02e7 into master May 10, 2020
@lidel lidel deleted the issue-595 branch May 10, 2020 19:54
@lidel lidel mentioned this pull request May 10, 2020
4 tasks
@jessicaschilling
Copy link
Contributor Author

Thanks for all those details!

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.

Fix Readme links in Preferences screen
2 participants