From 91a21c272960889afd4eaa431a3d29b7785b6efc Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sat, 16 May 2020 12:54:51 +0200 Subject: **General rewording, proof-reading, deduplication, shortening, reordering, simplification, cleanup/formatting/standardization** - standardize page names, rework documentation structure, update TOC - use same example paths everywhere - level 1 titles on all pages - fix broken links - .md suffix on all page links (works both from readthedocs and github repository views) **Server:** A full and concise installation guide with examples is a frequent request. The documentation should provide such a guide for basic installation needs, while explaining alternative/advanced configuration at the end. Links to reference guides and documentation should be used more frequently to avoid recommending an outdated or excessively complex configuration. - server: move most server-related info to server-configuration.md, cleanup/shorten - server: update list of php dependencies/libraries, link to composer.json - server: installation: support 3 install methods (from release zip, from sources, using docker) - server: installation: use rsync instead of mv as mv results will change depending of taget directory already existing or not - server: add example/basic usage of certbot - server, upgrade, installation: update file permissions setup, use sudo for upgrade operations in webserver document root - server: apache: add comments to configuration, fix and factorize file permissions setup, set cache-control header, deny access to dotfiles, add missing apache config steps, add http->https redirect example - server: nginx: refactor nginx configuration, add comments, DO log access to denied/protected files - server: add links to MDN for x-forwarded-* http headers explanation, cleanup/clarify robots.txt and crawlers section - server: bump file upload size limit to 100MB we have reports of bookmark exports weighing +40MB - i have a 13MB one here - server: simplify phpinfo documentation - server: move backup and restore information to dedicated page - docker: move all docker docs to Docker.md, simplify/ docker setup, add docker-compose.yml example, replace docker-101 with docker cheatsheet - troubleshooting: move all troubleshooting documentation to troubleshooting.md **Usage:** - index: add getting started section on index page - features/usage: move all usage-related documentation to usage.md, add links from the main feature list to corresponding usage docs, clarify/reword features list - shaarli configuration: add note about configuring from web interface **Removed:** - remove obsolete/orphan images - remove obsolete shaarchiver example - remove outdated "decode datastore content" snippet **Development:** - development: move development-related docs (static analysis, CI, unit tests, 3rd party libs, link structure/directory, guidelines, security....) to dev/ directory - development: Merge several pages to development.md - **Breaking change?:** remove mentions of 'stable' branch, switch to new branch/release model (master=latest commit, release=latest tag) - **Breaking change?:** refer to base sharing unit as "Shaare" everywhere (TODO: reflect changes in the code?) doc: update featues list/link to usage.md for details - development: directory structure: add note about required file permissions - .travis-ci.yml: add comments - .htaccess: add comment --- doc/md/Sharing-content.md | 71 ----------------------------------------------- 1 file changed, 71 deletions(-) delete mode 100644 doc/md/Sharing-content.md (limited to 'doc/md/Sharing-content.md') diff --git a/doc/md/Sharing-content.md b/doc/md/Sharing-content.md deleted file mode 100644 index 9a16fc62..00000000 --- a/doc/md/Sharing-content.md +++ /dev/null @@ -1,71 +0,0 @@ -Content posted to Shaarli is separated in items called _Shaares_. For each Shaare, -you can customize the following aspects: - - * URL to link to - * Title - * Free-text description - * Tags - * Public/private status - --------------------------------------------------------------------------------- - -## Adding new Shaares - -While logged in to your Shaarli, you can add new Shaares in several ways: - - * [+Shaare button](#shaare-button) - * [Bookmarklet](#bookmarklet) - * Third-party [apps and browser addons](Community-&-Related-software.md#mobile-apps) - * [REST API](https://shaarli.github.io/api-documentation/) - -### +Shaare button - - * While logged in to your Shaarli, click the **`+Shaare`** button located in the toolbar. - * Enter the URL of a link you want to share. - * Click `Add link` - * The `New Shaare` dialog appears, allowing you to fill in the details of your Shaare. - * The Description, Title, and Tags will help you find your Shaare later using tags or full-text search. - * You can also check the “Private” box so that the link is saved but only visible to you (the logged-in user). - * Click `Save`. - - - -### Bookmarklet - -The _Bookmarklet_ \[[1](https://en.wikipedia.org/wiki/Bookmarklet)\] is a special -browser bookmark you can use to add new content to your Shaarli. This bookmarklet is -compatible with Firefox, Opera, Chrome and Safari. To set it up: - - * Access the `Tools` page from the button in the toolbar. - * Drag the **`✚Shaare link` button** to your browser's bookmarks bar. - -Once this is done, you can shaare any URL you are visiting simply by clicking the -bookmarklet in your browser! The same `New Shaare` dialog as above is displayed. - -| Note | Websites which enforce Content Security Policy (CSP), such as github.com, disallow usage of bookmarklets. Unfortunately, there is nothing Shaarli can do about it. \[[1](https://github.com/shaarli/Shaarli/issues/196)]\ \[[2](https://bugzilla.mozilla.org/show_bug.cgi?id=866522)]\ \[[3](https://code.google.com/p/chromium/issues/detail?id=233903)]\ | -|---------|---------| - -| Note | Under Opera, you can't drag'n drop the button: You have to right-click on it and add a bookmark to your personal toolbar. | -|---------|---------| - -![](images/bookmarklet.png) - - --------------------------------------------------------------------------------- - -## Editing Shaares - -Any Shaare can edited by clicking its ![](images/edit_icon.png) `Edit` button. - -Editing a Shaare will not change it's permalink, each permalink always points to the -latest revision of a Shaare. - --------------------------------------------------------------------------------- - -## Using shaarli as a blog, notepad, pastebin... - -While adding or editing a link, leave the URL field blank to create a text-only -("note") post. This allows you to post any kind of text content, such as blog -articles, private or public notes, snippets... There is no character limit! You can -access your Shaare from its permalink. - -- cgit v1.2.3