diff --git a/README.md b/README.md index 9cd05949..11b83b60 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,11 @@

Astuto - An open source customer feedback tool 🦊 | Product Hunt Embed -
-

- ✨ Try it out -

Astuto is an open source customer feedback tool. It helps you collect, manage and prioritize feedback from your customers, so you can build a better product. - - - + ## Features @@ -25,12 +19,12 @@ Astuto is an open source customer feedback tool. It helps you collect, manage an - **Anonymous Feedback**: enable unregistered users to publish feedback - **... and more**: invitation system, brand customization, recap emails for administrators, private site settings, and more! +## Documentation + +Documentation website is not online anymore. You can read Astuto's documentation from the [GitHub repository](https://github.com/astuto/astuto-docs). + ## Get started -Read the [Deploy with Docker instructions](https://docs.astuto.io/deploy-docker) for the most comprehensive and up to date guide on installing and configuring Astuto. - -What you find below are minimal instructions to get you started as quickly as possible: - 0. Ensure you have Docker and Docker Compose installed 1. Create an empty folder 2. Inside that folder, create a `docker-compose.yml` file with the following content: @@ -57,21 +51,17 @@ services: volumes: dbdata: ``` -3. Edit the environment variables to fit your needs. You can find more information about env variables in the [documentation](https://docs.astuto.io/deploy-docker/#2-edit-environment-variables). +3. Edit the environment variables to fit your needs 4. Run `docker compose pull && docker compose up` 5. You should now have a running instance of Astuto on port 3000. A default user account has been created with credentials email: `admin@example.com`, password: `password`. -## Documentation - -Check out [docs.astuto.io](https://docs.astuto.io/) to learn how to deploy Astuto, configure custom OAuth providers and webhooks, use our REST API and more! - ## Contributing There are many ways to contribute to Astuto, not just coding. Proposing features, reporting issues, translating to a new language or improving documentation are a few examples! Please read our [contributing guidelines](https://github.com/riggraz/astuto/blob/main/CONTRIBUTING.md) to learn more. ## Credits -Astuto logo and all image assets are credited [here](https://astuto.io/credits). +Astuto logo and all image assets are credited [here](https://github.com/astuto/astuto-io/blob/main/src/pages/Credits.jsx). A huge thank you to code contributors diff --git a/app/javascript/components/Billing/index.tsx b/app/javascript/components/Billing/index.tsx index 45689fee..30a74919 100644 --- a/app/javascript/components/Billing/index.tsx +++ b/app/javascript/components/Billing/index.tsx @@ -171,21 +171,18 @@ const Billing = ({ } */} -

- If you want to manage your current subscription, please contact us via email. -

We do not accept new subscriptions right now.

-
+ {/*
window.open('https://astuto.io/terms-of-service', '_blank')} icon={}> Terms of Service window.open('https://astuto.io/privacy-policy', '_blank')} icon={}> Privacy Policy -
+
*/} ); } diff --git a/app/javascript/components/SiteSettings/Appearance/AppearanceSiteSettingsP.tsx b/app/javascript/components/SiteSettings/Appearance/AppearanceSiteSettingsP.tsx index 98f05ec7..0f253ae9 100644 --- a/app/javascript/components/SiteSettings/Appearance/AppearanceSiteSettingsP.tsx +++ b/app/javascript/components/SiteSettings/Appearance/AppearanceSiteSettingsP.tsx @@ -78,7 +78,7 @@ const AppearanceSiteSettingsP = ({

window.open('https://docs.astuto.io/appearance-customization/', '_blank')} + onClick={() => window.open('https://github.com/astuto/astuto-docs/blob/main/docs/appearance.md', '_blank')} icon={} > {I18n.t('site_settings.appearance.learn_more')} diff --git a/app/javascript/components/SiteSettings/Authentication/OAuthProvidersList.tsx b/app/javascript/components/SiteSettings/Authentication/OAuthProvidersList.tsx index 4b1ab76a..9b55d10d 100644 --- a/app/javascript/components/SiteSettings/Authentication/OAuthProvidersList.tsx +++ b/app/javascript/components/SiteSettings/Authentication/OAuthProvidersList.tsx @@ -35,7 +35,7 @@ const OAuthProvidersList = ({

window.open('https://docs.astuto.io/oauth/oauth-configuration-basics/', '_blank')} + onClick={() => window.open('https://github.com/astuto/astuto-docs/blob/main/docs/oauth/oauth-configuration-basics.md', '_blank')} icon={} > {I18n.t('site_settings.authentication.learn_more')} diff --git a/app/javascript/components/SiteSettings/General/GeneralSiteSettingsP.tsx b/app/javascript/components/SiteSettings/General/GeneralSiteSettingsP.tsx index 98fdfc87..3d5869b0 100644 --- a/app/javascript/components/SiteSettings/General/GeneralSiteSettingsP.tsx +++ b/app/javascript/components/SiteSettings/General/GeneralSiteSettingsP.tsx @@ -278,7 +278,7 @@ const GeneralSiteSettingsP = ({ }

window.open('https://docs.astuto.io/custom-domain', '_blank')} + onClick={() => window.open('https://github.com/astuto/astuto-docs/blob/main/docs/custom-domain.md', '_blank')} icon={} > {I18n.t('site_settings.general.custom_domain_learn_more')} diff --git a/app/javascript/components/SiteSettings/Webhooks/WebhooksIndexPage.tsx b/app/javascript/components/SiteSettings/Webhooks/WebhooksIndexPage.tsx index 138683b0..6973b9c4 100644 --- a/app/javascript/components/SiteSettings/Webhooks/WebhooksIndexPage.tsx +++ b/app/javascript/components/SiteSettings/Webhooks/WebhooksIndexPage.tsx @@ -48,7 +48,7 @@ const WebhooksIndexPage = ({

window.open('https://docs.astuto.io/webhooks/webhooks-introduction/', '_blank')} + onClick={() => window.open('https://github.com/astuto/astuto-docs/blob/main/docs/webhooks/webhooks-introduction.md', '_blank')} icon={} > {I18n.t('site_settings.webhooks.learn_more')} diff --git a/app/javascript/components/UserProfile/GenerateApiKeyDialog.tsx b/app/javascript/components/UserProfile/GenerateApiKeyDialog.tsx index e87013fb..eb5ab67d 100644 --- a/app/javascript/components/UserProfile/GenerateApiKeyDialog.tsx +++ b/app/javascript/components/UserProfile/GenerateApiKeyDialog.tsx @@ -81,14 +81,6 @@ const GenerateApiKeyDialog = ({ } -

- } - onClick={() => window.open('https://docs.astuto.io/api', '_blank')} - > - {I18n.t('common.forms.api_key.api_key_learn_more')} - - { error && {error} } ); diff --git a/app/javascript/components/common/PoweredByLink.tsx b/app/javascript/components/common/PoweredByLink.tsx index 223b03a9..649545c5 100644 --- a/app/javascript/components/common/PoweredByLink.tsx +++ b/app/javascript/components/common/PoweredByLink.tsx @@ -3,7 +3,7 @@ import I18n from 'i18n-js'; const PoweredByLink = () => (

- + { I18n.t('common.powered_by') } Astuto
diff --git a/app/views/devise/registrations/edit.html.erb b/app/views/devise/registrations/edit.html.erb index dcf8c256..c490aca5 100644 --- a/app/views/devise/registrations/edit.html.erb +++ b/app/views/devise/registrations/edit.html.erb @@ -78,7 +78,7 @@
<% else %> <% if not Rails.application.multi_tenancy? %> -

You have to enable Sidekiq to receive recap notifications.

+

You have to enable Sidekiq to receive recap notifications.

<% end %> <% end %> diff --git a/app/views/layouts/_header.html.erb b/app/views/layouts/_header.html.erb index c5760104..95934c54 100644 --- a/app/views/layouts/_header.html.erb +++ b/app/views/layouts/_header.html.erb @@ -88,7 +88,7 @@ <% unless @boards.empty? %> <%= link_to t('header.menu.tour'), @header_full_urls ? get_url_for(method(:board_url), resource: @boards.first, options: { tour: true }) : board_path(@boards.first, tour: true), class: 'dropdown-item tourDropdown' %> <% end %> - <%= link_to t('header.menu.docs'), 'https://docs.astuto.io', class: 'dropdown-item', target: '_blank' %> + <%= link_to t('header.menu.docs'), 'https://github.com/astuto/astuto-docs', class: 'dropdown-item', target: '_blank' %> <%= link_to t('header.menu.support'), Rails.application.multi_tenancy? ? 'mailto:info@astuto.io' : 'https://github.com/astuto/astuto/issues', class: 'dropdown-item', target: '_blank' %> diff --git a/app/views/tenant_mailer/trial_start.html.erb b/app/views/tenant_mailer/trial_start.html.erb index c440bc74..4ffa6918 100644 --- a/app/views/tenant_mailer/trial_start.html.erb +++ b/app/views/tenant_mailer/trial_start.html.erb @@ -15,7 +15,7 @@ Dive into your new feedback space at ">site settings. For more advanced configurations, such as custom OAuth providers or custom domains, you can refer to the Astuto documentation. +To customize your feedback space, just head to site settings. For more advanced configurations, such as custom OAuth providers or custom domains, you can refer to the Astuto documentation.