Skip to content

Commit

Permalink
Docs: Update URLs for easier maintenance
Browse files Browse the repository at this point in the history
  • Loading branch information
lastzero committed Feb 9, 2022
1 parent 7c4241f commit 628147a
Show file tree
Hide file tree
Showing 10 changed files with 72 additions and 73 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ assignees: ''

ONLY CREATE A NEW FEATURE REQUEST AFTER YOU HAVE VERIFIED THAT NO SIMILAR IDEA ALREADY EXISTS:

- Roadmap: https://github.com/photoprism/photoprism/projects/5
- Roadmap: https://link.photoprism.app/roadmap
- Open Issues: https://github.com/photoprism/photoprism/issues

Never use GitHub Issues if you have a general question, need help, or an issue has not (yet) been clearly identified. Thank you! 🙃
Expand Down
4 changes: 2 additions & 2 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Code of Conduct

## Rules ##
<img align="right" width="25%" src="https://da.photoprism.app/no-trolling/original.svg">
<img align="right" width="25%" src="https://cdn.photoprism.app/no-trolling/original.svg">

To keep it simple, we only have three basic rules:

Expand All @@ -17,7 +17,7 @@ The following non-exhaustive list provides specific guidelines and examples:
- avoid asking for [deadlines](https://docs.photoprism.app/developer-guide/code-quality/#go-slow-before-you-go-fast)
- don't feel entitled to free support, advice, or features if you are not a [contributor](https://docs.photoprism.app/developer-guide/), [sponsor](https://docs.photoprism.app/funding/), or paying customer
- before reporting a bug, try to [determine the cause of your problem](https://docs.photoprism.app/getting-started/troubleshooting/)
- if you have a [general question](https://github.com/photoprism/photoprism/discussions) or need [technical support](https://docs.photoprism.app/user-guide/#getting-support), don't use GitHub Issues
- if you have a [general question](https://link.photoprism.app/discussions) or need [technical support](https://docs.photoprism.app/user-guide/#getting-support), don't use GitHub Issues
- if you are having a bad day and want to offend someone, please go somewhere else

## Reporting ##
Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ We welcome contributions of any kind, including blog posts, tutorials, testing,

## Join the Community ##

Follow us on [Twitter](https://twitter.com/photoprism_app) and join the [Community Chat](https://gitter.im/browseyourlife/community)
Follow us on [Twitter](https://link.photoprism.app/twitter) and join the [Community Chat](https://link.photoprism.app/chat)
to get regular updates, connect with other contributors, and discuss your ideas.
Our [Code of Conduct](CODE_OF_CONDUCT.md) explains the "dos and don’ts."

Expand All @@ -16,15 +16,15 @@ Before reporting a bug, please use our [Troubleshooting Checklists](https://docs
to determine the cause of your problem. If you have a general question, need help, or an issue has not
(yet) been clearly identified:

- you are welcome to ask in our [Community Chat](https://gitter.im/browseyourlife/community)
- or post your question in [GitHub Discussions](https://github.com/photoprism/photoprism/discussions)
- you are welcome to ask in our [Community Chat](https://link.photoprism.app/chat)
- or post your question in [GitHub Discussions](https://link.photoprism.app/discussions

### GitHub Issues ###

Never report a bug unless you are certain to have found a fully reproducible and previously unreported issue that
must be fixed directly in [our source code](https://github.com/photoprism/photoprism):

- [contact us](https://photoprism.app/contact) or [a community member](https://github.com/photoprism/photoprism/discussions) if you need help, it could be a local configuration problem, or a misunderstanding in how the software works
- [contact us](https://photoprism.app/contact) or [a community member](https://link.photoprism.app/discussions) if you need help, it could be a local configuration problem, or a misunderstanding in how the software works
- this gives our team the opportunity to [improve the documentation](https://docs.photoprism.app/getting-started/troubleshooting/) and provide best-in-class support to you, instead of handling unclear and/or duplicate bug reports
- when reporting a problem, always include the software versions you are using and other information about your environment such as [browser, browser plugins](https://docs.photoprism.app/getting-started/troubleshooting/browsers/), operating system, storage type, memory size, and processor

Expand All @@ -40,7 +40,7 @@ new features, bug fixes, and documentation improvements. Issues labeled [help wa

### Contributor License Agreement (CLA) ###

After submitting your first pull request, you will automatically be asked to [accept our CLA](https://cla-assistant.io/photoprism/photoprism):
After submitting your first pull request, you will automatically be asked to [accept our CLA](https://link.photoprism.app/cla):

- this gives us the ability to [(re-)license all code and documentation](https://en.wikipedia.org/wiki/Software_relicensing) at any time, *almost* as if we had created it ourselves (you retain the rights to your own work, which may be different for other CLAs)
- otherwise, we cannot accept pull requests, as this would mean that we are not able to change the license of our software and documentation at a later time, even though most of it was developed and written by us
Expand All @@ -60,4 +60,4 @@ You can also contribute by...

----

*PhotoPrism® is a [registered trademark](https://photoprism.app/trademark). Docs are [available](https://github.com/photoprism/photoprism-docs) under the [CC BY-NC-SA 4.0 License](https://creativecommons.org/licenses/by-nc-sa/4.0/); [additional terms](https://github.com/photoprism/photoprism/blob/develop/assets/README.md) may apply. By using our software, you agree to our [terms of service](https://photoprism.app/terms).*
*PhotoPrism® is a [registered trademark](https://photoprism.app/trademark). Docs are [available](https://link.photoprism.app/github-docs) under the [CC BY-NC-SA 4.0 License](https://creativecommons.org/licenses/by-nc-sa/4.0/); [additional terms](https://github.com/photoprism/photoprism/blob/develop/assets/README.md) may apply. By using our software, you agree to our [terms of service](https://photoprism.app/terms).*
61 changes: 30 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,33 @@ PhotoPrism: Browse Your Life in Pictures
[![License: AGPL](https://img.shields.io/badge/license-AGPL-blue.svg)](https://docs.photoprism.app/license/)
[![GitHub contributors](https://img.shields.io/github/contributors/photoprism/photoprism.svg)](https://photoprism.app/team)
[![Documentation](https://img.shields.io/badge/read-the%20docs-4aa087.svg)](https://docs.photoprism.app/)
[![Community Chat](https://img.shields.io/badge/chat-on%20gitter-4aa087.svg)](https://gitter.im/browseyourlife/community)
[![GitHub Discussions](https://img.shields.io/badge/ask-%20on%20github-4d6a91.svg)](https://github.com/photoprism/photoprism/discussions)
[![Twitter](https://img.shields.io/badge/follow-@photoprism_app-00acee.svg)](https://twitter.com/photoprism_app)
[![Reddit](https://img.shields.io/badge/join-/r/photoprism-EC5800.svg)](https://www.reddit.com/r/photoprism/)
[![Community Chat](https://img.shields.io/badge/chat-on%20gitter-4aa087.svg)](https://link.photoprism.app/chat)
[![GitHub Discussions](https://img.shields.io/badge/ask-%20on%20github-4d6a91.svg)](https://link.photoprism.app/discussions)
[![Twitter](https://img.shields.io/badge/follow-@photoprism_app-00acee.svg)](https://link.photoprism.app/twitter)
[![Reddit](https://img.shields.io/badge/join-/r/photoprism-EC5800.svg)](https://link.photoprism.app/reddit)

PhotoPrism® is an AI-powered app for browsing, organizing & sharing your photo collection.
It makes use of the latest technologies to tag and find pictures automatically without getting in your way.
You can run it at home, on a private server, or in the cloud.

![](https://dl.photoprism.app/img/ui/desktop-1000px.jpg)

To get a first impression, you are welcome to play with our public demo at [demo.photoprism.app](https://demo.photoprism.app/)
(also available in [Deutsch](https://demo-de.photoprism.app/), [Français](https://demo-fr.photoprism.app/), and [汉语](https://demo-zh.photoprism.app/)).
To get a first impression, you are welcome to play with our public demo at [try.photoprism.app](https://try.photoprism.app/).

## Feature Overview ##

* Browse [all your photos](https://docs.photoprism.app/user-guide/organize/browse/) and [videos](https://demo.photoprism.app/videos) without worrying about [RAW conversion, duplicates or video formats](https://docs.photoprism.app/user-guide/settings/library/)
* Easily find specific pictures using [powerful search filters](https://demo.photoprism.app/browse?view=cards&q=flower%20color%3Ared)
* Browse [all your photos](https://docs.photoprism.app/user-guide/organize/browse/) and [videos](https://try.photoprism.app/videos) without worrying about [RAW conversion, duplicates or video formats](https://docs.photoprism.app/user-guide/settings/library/)
* Easily find specific pictures using [powerful search filters](https://try.photoprism.app/browse?view=cards&q=flower%20color%3Ared)
* Privacy-friendly: No data is ever sent to Google, Amazon, Facebook, or Apple unless you explicitly upload files to one of their services 🔐
* Recognizes [the faces of your family and friends](https://demo.photoprism.app/people)
* [Automatic classification](https://demo.photoprism.app/labels) of pictures based on their content and location
* [Play Live Photos](https://demo.photoprism.app/live) by hovering over them in [albums](https://demo.photoprism.app/albums) and [search results](https://demo.photoprism.app/browse?view=cards&q=type%3Alive)
* Since the [User Interface](https://demo.photoprism.app/) is a [Progressive Web App](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps),
* Recognizes [the faces of your family and friends](https://try.photoprism.app/people)
* [Automatic classification](https://try.photoprism.app/labels) of pictures based on their content and location
* [Play Live Photos](https://try.photoprism.app/live) by hovering over them in [albums](https://try.photoprism.app/albums) and [search results](https://try.photoprism.app/browse?view=cards&q=type%3Alive)
* Since the [User Interface](https://try.photoprism.app/) is a [Progressive Web App](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps),
it provides a native app-like experience, and you can conveniently install it on the home screen of all major operating systems and mobile devices
* Includes four high-resolution [World Maps](https://demo.photoprism.app/places) to bring back the memories of your favorite trips
* Includes four high-resolution [World Maps](https://try.photoprism.app/places) to bring back the memories of your favorite trips
* Metadata is extracted and merged from Exif, XMP, and other sources such as Google Photos
* Many more image properties like [Colors](https://demo.photoprism.app/browse?view=cards&q=color:red), [Chroma](https://demo.photoprism.app/browse?view=cards&q=mono%3Atrue), and [Quality](https://demo.photoprism.app/review) can be searched as well
* Use [PhotoSync](https://www.photosync-app.com/) to securely backup iOS and Android phones in the background
* Many more image properties like [Colors](https://try.photoprism.app/browse?view=cards&q=color:red), [Chroma](https://try.photoprism.app/browse?view=cards&q=mono%3Atrue), and [Quality](https://try.photoprism.app/review) can be searched as well
* Use [PhotoSync](https://link.photoprism.app/photosync) to securely backup iOS and Android phones in the background
* WebDAV clients such as Microsoft's Windows Explorer and Apple's Finder [can connect directly](https://docs.photoprism.app/user-guide/sync/webdav/) to PhotoPrism, allowing you to open, edit, and delete files from your computer as if they were local

## Getting Started ##
Expand All @@ -43,7 +42,7 @@ all you need is a Web browser and [Docker](https://docs.docker.com/get-docker/)
It is available for Mac, Linux, and Windows.

The [stable version](https://docs.photoprism.app/release-notes/) and development
preview have been built into a single [multi-arch image](https://hub.docker.com/r/photoprism/photoprism) for 64-bit AMD, Intel,
preview have been built into a single [multi-arch image](https://link.photoprism.app/docker-hub) for 64-bit AMD, Intel,
and ARM processors. That means, [Raspberry Pi](https://docs.photoprism.app/getting-started/raspberry-pi/) 3 / 4 owners can pull
from the same repository, enjoy the exact same functionality, and can follow the regular
[installation instructions](https://docs.photoprism.app/getting-started/docker-compose/)
Expand All @@ -52,18 +51,18 @@ after going through a short list of [requirements](https://docs.photoprism.app/g
Existing users are advised to update their `docker-compose.yml` config based on our examples
available at [dl.photoprism.app/docker](https://dl.photoprism.app/docker/).

## Back us on [Patreon](https://www.patreon.com/photoprism) or [GitHub Sponsors](https://github.com/sponsors/photoprism) 💎 ##
## Back us on [Patreon](https://link.photoprism.app/patreon) or [GitHub Sponsors](https://link.photoprism.app/sponsor) 💎 ##

**PhotoPrism is 100% self-funded and independent.** Your continued support helps us provide [regular updates](https://docs.photoprism.app/release-notes/)
and services like [world maps](https://demo.photoprism.app/places).
and services like [world maps](https://try.photoprism.app/places).
Sponsors get access to [additional features](https://github.com/photoprism/photoprism/issues?q=label%3Asponsor-feature),
receive direct [technical support](https://photoprism.app/contact) via email, and can join our private chat room
on [matrix.org](https://matrix.org/).

We currently have the following sponsorship options:

- [GitHub Sponsors](https://github.com/sponsors/photoprism) is priced in USD and also offers [one-time donations](https://github.com/sponsors/photoprism?frequency=one-time)
- [Patreon](https://www.patreon.com/photoprism) is priced in Euro and also offers yearly payments
- [GitHub Sponsors](https://link.photoprism.app/sponsor) is priced in USD and also offers [one-time donations](https://link.photoprism.app/donate)
- [Patreon](https://link.photoprism.app/patreon) is priced in Euro and also offers yearly payments
- Stripe will be available in early 2022, so you can sign up directly in the app without having a Patreon or GitHub account
- you are welcome to [contact us](https://photoprism.app/contact) for [crypto donations](https://photoprism.app/crypto-donations) and other options

Expand All @@ -73,12 +72,12 @@ It provides additional motivation to keep going.
## Upcoming Features and Improvements ##

**Our vision is to provide the most user- and privacy-friendly solution to keep your pictures organized and accessible.**
The [roadmap](https://github.com/photoprism/photoprism/projects/5) shows what tasks are in progress,
The [roadmap](https://link.photoprism.app/roadmap) shows what tasks are in progress,
what needs testing, and which features are going to be implemented next.
Please give ideas you like a thumbs-up 👍 , so that we know what is most popular.

Ideas endorsed by [silver, gold, and platinum sponsors](SPONSORS.md) receive a [golden label](https://github.com/photoprism/photoprism/issues?q=is%3Aissue+is%3Aopen+label%3Asponsor)
and will be prioritized on the [roadmap](https://github.com/photoprism/photoprism/projects/5).
Ideas endorsed by [silver, gold, and platinum sponsors](https://link.photoprism.app/sponsors) receive a [golden label](https://github.com/photoprism/photoprism/issues?q=is%3Aissue+is%3Aopen+label%3Asponsor)
and will be prioritized on the [roadmap](https://link.photoprism.app/roadmap).

We have a zero bug policy and do our best to help users when they need support or have other questions.
This comes at a price, as we can't give exact deadlines for new features.
Expand All @@ -91,29 +90,29 @@ Having said that, funding really has the highest impact. So users can do their p
Before submitting a support request, please use our [Troubleshooting Checklists](https://docs.photoprism.app/getting-started/troubleshooting/)
to determine the cause of your problem. If this doesn't help, or you have other questions:

- you are welcome to join us on [Reddit](https://www.reddit.com/r/photoprism/)
- post your question in [GitHub Discussions](https://github.com/photoprism/photoprism/discussions)
- or ask in our [Community Chat](https://gitter.im/browseyourlife/community)
- you are welcome to join us on [Reddit](https://link.photoprism.app/reddit)
- post your question in [GitHub Discussions](https://link.photoprism.app/discussions)
- or ask in our [Community Chat](https://link.photoprism.app/chat)

In addition, [sponsors](https://github.com/photoprism/photoprism/blob/develop/SPONSORS.md) receive direct
In addition, [sponsors](https://link.photoprism.app/sponsors) receive direct
[technical support](https://photoprism.app/contact) via email.

We'll do our best to answer all your questions. In return, we ask you to [back us](https://docs.photoprism.app/funding/)
on [Patreon](https://www.patreon.com/photoprism) or [GitHub Sponsors](https://github.com/sponsors/photoprism).
on [Patreon](https://link.photoprism.app/patreon) or [GitHub Sponsors](https://link.photoprism.app/sponsor).
Think of "free software" as in "free speech," not as in "free beer". Thank You! 💜

### GitHub Issues ###

We kindly ask you not to report bugs via GitHub Issues unless you are certain to have found a fully reproducible and
previously unreported issue that must be fixed directly in the app. [Contact us](https://photoprism.app/contact)
or [a community member](https://github.com/photoprism/photoprism/discussions) if you need help, it could be a local
or [a community member](https://link.photoprism.app/discussions) if you need help, it could be a local
configuration problem, or a misunderstanding in how the software works. This gives our team the opportunity
to [improve the documentation](https://docs.photoprism.app/getting-started/troubleshooting/) and provide best-in-class
support to you, instead of handling unclear and/or duplicate bug reports.

## Join the Community ##

Follow us on [Twitter](https://twitter.com/photoprism_app) and join the [Community Chat](https://gitter.im/browseyourlife/community)
Follow us on [Twitter](https://link.photoprism.app/twitter) and join the [Community Chat](https://link.photoprism.app/chat)
to get regular updates, connect with other users, and discuss your ideas.
Our [Code of Conduct](CODE_OF_CONDUCT.md) explains the "dos and don’ts."

Expand All @@ -125,4 +124,4 @@ We welcome [contributions](CONTRIBUTING.md) of any kind, including blog posts, t

----

*PhotoPrism® is a [registered trademark](https://photoprism.app/trademark). Docs are [available](https://github.com/photoprism/photoprism-docs) under the [CC BY-NC-SA 4.0 License](https://creativecommons.org/licenses/by-nc-sa/4.0/); [additional terms](https://github.com/photoprism/photoprism/blob/develop/assets/README.md) may apply. By using our software, you agree to our [terms of service](https://photoprism.app/terms).*
*PhotoPrism® is a [registered trademark](https://photoprism.app/trademark). Docs are [available](https://link.photoprism.app/github-docs) under the [CC BY-NC-SA 4.0 License](https://creativecommons.org/licenses/by-nc-sa/4.0/); [additional terms](https://github.com/photoprism/photoprism/blob/develop/assets/README.md) may apply. By using our software, you agree to our [terms of service](https://photoprism.app/terms).*
Loading

0 comments on commit 628147a

Please sign in to comment.