From 7e2410a0edabae9c3293ab845eccd49045007170 Mon Sep 17 00:00:00 2001 From: Manav Rathi Date: Thu, 7 Mar 2024 14:48:28 +0530 Subject: [PATCH] More --- docs/docs/.vitepress/sidebar.ts | 14 ++- docs/docs/about/contribute.md | 2 + docs/docs/about/index.md | 111 ++++++---------------- docs/docs/index.md | 8 +- docs/docs/photos/getting-started/index.md | 0 docs/docs/photos/index.md | 56 ++++------- docs/docs/photos/misc/contributors.md | 0 7 files changed, 70 insertions(+), 121 deletions(-) delete mode 100644 docs/docs/photos/getting-started/index.md delete mode 100644 docs/docs/photos/misc/contributors.md diff --git a/docs/docs/.vitepress/sidebar.ts b/docs/docs/.vitepress/sidebar.ts index 1bfabc652c..4344e5a6dc 100644 --- a/docs/docs/.vitepress/sidebar.ts +++ b/docs/docs/.vitepress/sidebar.ts @@ -4,11 +4,23 @@ export const sidebar = [ { text: "Photos", - collapsed: true, items: [ + { text: "Introduction", link: "/photos/" }, { text: "Features", + collapsed: true, + items: [{ text: "Introduction", link: "/photos/" }], }, + { + text: "FAQ", + collapsed: true, + items: [{ text: "Introduction", link: "/photos/" }], + }, + { + text: "Troubleshooting", + collapsed: true, + items: [{ text: "Introduction", link: "/photos/" }], + } ], }, { diff --git a/docs/docs/about/contribute.md b/docs/docs/about/contribute.md index 8217fb5076..3addd2e606 100644 --- a/docs/docs/about/contribute.md +++ b/docs/docs/about/contribute.md @@ -3,6 +3,8 @@ title: Contribute description: Details about how to contribute to Ente's docs --- +# Contributing + To contribute to these docs, you can use the "Edit this page" button at the bottom of each page. This will allow you to directly edit the markdown file that is used to generate this documentation and open a quick pull request directly diff --git a/docs/docs/about/index.md b/docs/docs/about/index.md index d52fbf1c9c..27a0b4bb9f 100644 --- a/docs/docs/about/index.md +++ b/docs/docs/about/index.md @@ -5,19 +5,26 @@ description: > that we make. --- -Ente is a platform for privately, reliably, and securely storing your data on -the cloud. On top of this platform, Ente offers two products currently: +# About -* Ente Photos - An alternative to Google Photos and Apple Photos +Ente is a end-to-end encrypted platform for privately, reliably, and securely +storing your data on the cloud. On top of this platform, Ente offers two +products: -* Ente Auth - A (free!) app for storing your 2FA codes. +* **Ente Photos** - An alternative to Google Photos and Apple Photos -and more products are in the pipeline. +* **Ente Auth** - A free 2FA alternative to Authy + +Both these apps are available for all desktop (Linux, Mac, Windows) and mobile +(Android, iOS and F-Droid) platforms. They also work directly in your web +browser without you needing to install anything. + +More products are in the pipeline. ## History -Ente was the founded by Vishnu Mohandas, who is also the Ente's CEO, in response -to privacy concerns with major tech companies. The underlying motivation was the +Ente was the founded by Vishnu Mohandas (he's also Ente's CEO) in response to +privacy concerns with major tech companies. The underlying motivation was the understanding that big tech had no incentive to fix their act, but with end-to-end encrypted cross platform apps, there was a way for people to take back control over their own data without sacrificing on features. @@ -29,9 +36,9 @@ has the literal meaning "my photos". This was a good name, but still Vishnu looked around for better ones. But one day, he discovered that "ente" means "duck" in German. This unexpected -connection sealed the deal! We should ask him why he likes ducks so much, but +connection sealed the deal. We should ask him why he likes ducks so much, but apparently he does, so this dual meaning ("mine" / "duck") led him to finalize -the name, and also led to the adoption of the duck as Ente's mascot, "Ducky": +the name, and also led to the adoption of "Ducky", Ente's mascot:
@@ -43,80 +50,20 @@ the name, and also led to the adoption of the duck as Ente's mascot, "Ducky": en-_tay_. Like cafe. ---- +## Get in touch -# Products +If you have a support query that is not answered by these docs, please reach out +to our Customer Support by sending an email to support@ente.io -Ente currently offers Photo and Auth. Additionally, there are some other -products (Lockers and Legacy) that are being considered. +To stay up to date with new product launches, and behind the scenes details of +how we're building Ente, you can read our [blog](https://ente.io/blog) (or +subscribe to it via [RSS](https://ente.io/blog/rss.xml)) -## Ente Photos - -Ente Photos goes beyond traditional cloud storage, prioritizing your privacy and -the safety of your cherished memories. All your photos, along with their -metadata, are stored end-to-end encrypted, ensuring that only you have access to -your data. - -Ente preserves your encrypted photos across three different clouds in three -separate locations, including an underground fallout shelter. This multi-layered -backup strategy provides a high level of reliability. - -Ente photos is available for Android, iOS, Linux, Mac, Windows and the web. - -# Ente Auth - -Ente auth is ust an authenticator app; it's an open-source initiative -dedicated to securing your 2FA secrets. Now, you can backup and view your -two-factor authentication secrets seamlessly. find more information about the -project on GitHub at github.com/ente-io/auth. - -As a token of gratitude to the community that has supported us, Ente Auth is -offered as a free service. If in the future we convert this to a paid service, -existing users will be grandfathered in. - -Ente auth is available on Android, iOS, and the web - -# Connect with Ente - -## Customer support - -Connect with our support team for swift assistance and expert guidance email us -@support@ente.io. -Reach out to our dev team @team@ente.io, even our CEO and CTO personally -responds here. - -## Blog - -As Ente continues to evolve, So does our story. Follow our blog @ -https://ente.io/blog As Ente undergoes continuous growth and development, our -narrative unfolds. Explore our blog for exclusive company updates that offer an -insider's perspective. Regularly visit the Ente blog to maintain your -connection, stay well informed, and draw insipration. - -## Roadmap - -You plays a pivotal role in shaping the future direction of Ente's product, and -we invite you to be an integral part of it. - -Take a look at our roadmap to see where we're headed -https://roadmap.ente.io/roadmap/ - -# Community - -#### Join our vibrant community and stay updated on all things on Ente! Follow us on various platforms for the latest news, updates, and engaging content - -#### Discord - -Join our Discord for real-time discussions, solutions to queries, and a thriving -camaraderie. Stay updated on all things on Ente! - -🐦 Twitter: https://twitter.com/enteio - -πŸ”— Reddit: https://www.reddit.com/r/enteio - -πŸ“Έ Instagram: https://www.instagram.com/ente.app/ - -🐘 Mastodon: https://mstdn.social/@ente - -πŸ”— LinkedIn: https://www.linkedin.com/company/ente-io/ +To suggest new features and/or offer your perspective on how we should design +planned and upcoming features, use our [GitHub +discussions](https://github.com/ente-io/ente/discussions) +Or if you'd just like to hang out, join our +[Discord](https://discord.gg/z2YVKkycX3), follow us on +[Twitter](https://twitter.com/enteio) or give us a shout out on +[Mastodon](https://mstdn.social/@ente) diff --git a/docs/docs/index.md b/docs/docs/index.md index 4b4a382e35..0f9a844979 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -2,12 +2,14 @@ title: Home --- -Hello. This site contains documentation and help for Ente Photos and Ente Auth. +# Welcome! + +This site contains documentation and help for Ente Photos and Ente Auth. It describes various features, and also offers various troubleshooting suggestions. -Use the **sidebar menu** to navigate to information about the product (Photos or -Auth) you'd like to know more about. Or the **search** at the top to try and +Use the **sidebar** menu to navigate to information about the product (Photos or +Auth) you'd like to know more about. Or use the **search** at the top to try and jump directly to page that might contain the information you need. To know more about Ente, see [about](/about/) or visit our website diff --git a/docs/docs/photos/getting-started/index.md b/docs/docs/photos/getting-started/index.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/docs/photos/index.md b/docs/docs/photos/index.md index 7fd7214a1f..058fd63351 100644 --- a/docs/docs/photos/index.md +++ b/docs/docs/photos/index.md @@ -1,42 +1,28 @@ -# Welcome to Help! +--- +title: Ente Photos +description: User guide for Ente Photos +--- -Welcome to Ente Photos Help! If you're new to Ente Photos, our -[Quick Start](./getting-started/index.md) and [FAQs](./faq/faq.md) are great -places to begin. +# Welcome to the Ente Auth's User Guide! -If you can’t find an answer, please [ask the community](https://ente.io/discord) -or write to **support@ente.io**. +Ente Auth is a free, cross-platform, end-to-end encrypted authenticator app. You +can use it to safely store your 2FA codes (second-factor authentication codes). -To send a bug report or a feature suggestion, you can use -[Github Issues](https://github.com/ente-io/photos-app/issues). +> [!CAUTION] +> +> These docs are still incomplete. If you feel like contributing though, help us +> [fill them in](https://github.com/ente-io/ente/docs). -Feedback about this documentation can be shared on our -[Discord Server](https://ente.io/discord) in the **\#docs** channel. We would -love to hear your thoughts on anything we can fix or improve. +# Ente Photos -## About Ente Photos +Ente Photos is an end-to-end encrypted alternative to Google Photos and Apple +Photos. You can use it to safely and securely store your photos on the cloud. -[Ente Photos](https://ente.io) is a safe home for your photos and videos. +While security and privacy form the bedrock of Ente Photos, it is not at the +cost of usability. The user interface is simple, and we are continuously working +to make it even simpler. The goal is a product that can be used by people with +all sorts of technical ability and background. -You can store, share, and re-discover your moments with absolute privacy. - -## About Ente Auth - -[Ente Auth](https://ente.io/auth) is a secure, end-to-end encrypted 2FA app with -multi-platform sync. - -Learn more about Auth [here](../authenticator/). - -## Contributing - -The source for this documentation is available at -[github.com/ente-io/docs](https://github.com/ente-io/docs). - -Please see our -[contribution guide](https://github.com/ente-io/docs#contributing). We'd be -grateful for any fixes and improvements! - -Once your contributions are accepted, please add yourself to the list of -[Contributors](./misc/contributors.md). - -Thank you! +These help docs are divided into three sections: Features, FAQ and +Troubleshooting. Choose the relevant page from the sidebar menu, or use the +search at the top. diff --git a/docs/docs/photos/misc/contributors.md b/docs/docs/photos/misc/contributors.md deleted file mode 100644 index e69de29bb2..0000000000