A .gitignore => .gitignore +1 -0
M getting-started.md => getting-started.md +6 -0
@@ 159,3 159,9 @@ To add new new short URL, login to your account and do the following:
1. Click the "Save" button.
All done. You can now see the new URL in your short listings.
+
+# Importing data
+
+You can quickly populate your account organization by importing data from
+various sources. Please see the [Import page](import-export.md) for more
+information on this process.
A import-export.md => import-export.md +49 -0
@@ 0,0 1,49 @@
+---
+title: 'Import and export data with LinkTaco'
+description: 'How to import or export data with LinkTaco'
+---
+
+We've made it easy to migrate to LinkTaco and populate your organizations with
+the bookmarks and notes you want to save. Also all data in your LinkTaco
+account is yours. You can export it anytime you'd like.
+
+# Importing
+
+Currently you can import bookmarks (links and notes) from [Pinboard][pb],
+Firefox, Chrome, and Safari. It's a very straight forward process for each of
+these and shouldn't take more than a minute or two to complete.
+
+You must login to your account and do the following:
+
+1. Click "Settings" on the left menu
+1. Click the "Manage Organizations" button on the settings page.
+1. Find the organization you want in your list click the "Actions" button.
+1. Click the "Import" menu option
+1. Select the data source you plan to import.
+1. View the export instructions from the selected data source. They are
+ automatically updated in the bottom of the form when the data source is
+ changed.
+1. Follow the export instructions to obtain the import source file.
+1. Attach the exported source file into the import form.
+1. Click the "Import" button.
+
+That's it. An import is usually pretty instantaneous but depending on the size
+of the data being imported it may take a minute or two for it to show in your
+organization.
+
+[pb]: https://pinboard.in
+
+# Exporting
+
+LinkTaco allows you to export your bookmarks data in JSON or HTML data formats. To
+export your data you must first login to your account and do the following:
+
+1. Click "Settings" on the left menu
+1. Click the "Manage Organizations" button on the settings page.
+1. Find the organization you want in your list click the "Actions" button.
+1. Click the "Export" menu option
+1. Select the data format you'd like to export in (JSON or HTML)
+1. Click the "Export" button.
+1. Save the file to your local system.
+
+That's it.
M index.md => index.md +2 -0
@@ 8,6 8,8 @@ description: 'Documentation for the software and usage of LinkTaco'
# How to Use LinkTaco
- [Getting Started](getting-started.md)
+- [Understanding Organizations](organizations.md)
+- [Import / Export Data](import-export.md)
- [Custom Domains](custom-domains.md)
# Technical / Development
A organizations.md => organizations.md +97 -0
@@ 0,0 1,97 @@
+---
+title: 'Understanding Organizations in LinkTaco'
+description: 'What are organizations in LinkTaco?'
+---
+
+In LinkTaco, you have one account. Each account can own "unlimited"
+organizations. What is the difference between the two?
+
+An account is what you use to login. Think of it like your email and password.
+This is the identity that is used to link all your data together as owned by
+your account.
+
+An organization is more like a grouping of data. So all your bookmarks,
+listings, shorts, QR codes, custom domains, etc. all are linked to the given
+organization.
+
+Organizations are also what are paid for. So when you want to upgrade to a paid
+organization it's done so at the organization level. Since each account can
+have multiple organizations this allows an account to combine both paid
+organizations and free organizations.
+
+Every account can have up to **two free organizations**. After that if you'd
+like to add a new free organization you must pay for an existing organization
+first. This will free up a new free organization slot and you can then create
+your new organization.
+
+# Difference between free and paid organizations
+
+A free account can do pretty much everything a paid organization can do but
+with some limitations. Probably the biggest one is that free organizations can
+not save private links or notes. All free organization data is public facing.
+For most cases this is not a big deal but if you'd like to save private links
+and notes, then you should pay for your organization. It's very affordable and
+helps continue the development and operation of LinkTaco.
+
+You can see all of what's included on the [pricing page][pricing].
+
+There are also two types of paid plans. There is Personal and Business.
+Personal plans are billed on a yearly basis and Business are billed monthly.
+They are similar except the Business plan has a few extra benefits that are
+useful for organizations with multiple users who want to collaborate.
+
+Some of the bigger advantages of a paid organization is:
+
+- Private bookmarks & notes
+- The use of custom domains for your organization services
+- Full analytics
+- Collaboration with other users (Business)
+- Unlimited users can be a part of the paid organization (Business)
+- Integration with third parties (Slack, MatterMost, etc.) (Business)
+
+If you would like a paid Personal account and can't afford it we are happy to
+sponsor accounts on case-by-case basis. Also if you're an open source project
+who would like to have a paid account for the project we would be happy to
+help. In both cases above please send an email to
+[hello@linktaco.com][ltemail] and explain your situation.
+
+[pricing]: https://linktaco.com/pricing
+[ltemail]: mailto:hello@linktaco.com
+
+# Using Bookmarks, Notes, Listings and Shorts
+
+If you haven't seen the [Getting Started](getting-started.md) page yet, this
+explains how to use these services. You can change which organization is
+currently in use by selecting the organization you want in the drop down select
+field in the top left corner. You must be logged in to see this.
+
+Then just save your links as you would always do. The organization it's saved
+too is the one currently selected (though you can optionally change that in the
+various data input forms)
+
+# Managing your organizations
+
+Because each organization is it's own entity with it's own settings, bookmarks,
+listings, etc. the settings are also grouped together by organization.
+
+You can find and manage your organizations by doing the following:
+
+1. Click "Settings" on the left menu
+1. Click the "Manage Organizations" button on the settings page.
+1. Find the organization you want in your list (if you have many there is a
+ search box at the top of the listing page to filter your organizations).
+1. Click the "Actions" button and you will have the following options in the
+ menu:
+ - Manage Subscription
+ - Payment History
+ - Edit
+ - [Export](import-export.md)
+ - [Import](import-export.md)
+ - [Domains](custom-domains.md)
+ - Integrations
+ - Manage Members
+1. Select the menu item you want and you will directed to that specific
+ settings page for the organization.
+
+Each settings page is pretty self explanatory. The options are linked to
+specific help pages if they exist.