mirror of
https://github.com/astuto/astuto.git
synced 2025-12-14 18:57:51 +01:00
Update README and remove old links (#481)
- Remove links to demo and docs website from README
- Remove most links across the codebase referring to docs.astuto.io and astuto.io
Goodbye, Astuto 🥲
This commit is contained in:
committed by
GitHub
parent
d85bce76ad
commit
9176b96167
24
README.md
24
README.md
@@ -3,17 +3,11 @@
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="https://www.producthunt.com/posts/astuto?utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-astuto" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=179870&theme=neutral&period=daily" alt="Astuto - An open source customer feedback tool 🦊 | Product Hunt Embed" style="width: 250px; height: 54px;" width="250px" height="54px" /></a>
|
||||
<br>
|
||||
<h3 align="center">
|
||||
<a href="https://feedback.astuto.io/">✨ Try it out</a>
|
||||
</h3>
|
||||
</p>
|
||||
|
||||
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.
|
||||
|
||||
<a href="https://feedback.astuto.io/">
|
||||
<img src="./images/hero-image.png" />
|
||||
</a>
|
||||
<img src="./images/hero-image.png" />
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
@@ -171,21 +171,18 @@ const Billing = ({
|
||||
</div>
|
||||
} */}
|
||||
|
||||
<p>
|
||||
If you want to manage your current subscription, please <a href="mailto:info@astuto.io">contact us via email</a>.
|
||||
</p>
|
||||
<p>
|
||||
We do not accept new subscriptions right now.
|
||||
</p>
|
||||
|
||||
<div className="billingUsefulLinks">
|
||||
{/* <div className="billingUsefulLinks">
|
||||
<ActionLink onClick={() => window.open('https://astuto.io/terms-of-service', '_blank')} icon={<LearnMoreIcon />}>
|
||||
Terms of Service
|
||||
</ActionLink>
|
||||
<ActionLink onClick={() => window.open('https://astuto.io/privacy-policy', '_blank')} icon={<LearnMoreIcon />}>
|
||||
Privacy Policy
|
||||
</ActionLink>
|
||||
</div>
|
||||
</div> */}
|
||||
</Box>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -78,7 +78,7 @@ const AppearanceSiteSettingsP = ({
|
||||
|
||||
<p style={{textAlign: 'left'}}>
|
||||
<ActionLink
|
||||
onClick={() => 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={<LearnMoreIcon />}
|
||||
>
|
||||
{I18n.t('site_settings.appearance.learn_more')}
|
||||
|
||||
@@ -35,7 +35,7 @@ const OAuthProvidersList = ({
|
||||
|
||||
<p style={{textAlign: 'left'}}>
|
||||
<ActionLink
|
||||
onClick={() => 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={<LearnMoreIcon />}
|
||||
>
|
||||
{I18n.t('site_settings.authentication.learn_more')}
|
||||
|
||||
@@ -278,7 +278,7 @@ const GeneralSiteSettingsP = ({
|
||||
}
|
||||
<div style={{marginTop: 8}}>
|
||||
<ActionLink
|
||||
onClick={() => 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={<LearnMoreIcon />}
|
||||
>
|
||||
{I18n.t('site_settings.general.custom_domain_learn_more')}
|
||||
|
||||
@@ -48,7 +48,7 @@ const WebhooksIndexPage = ({
|
||||
|
||||
<p style={{textAlign: 'left'}}>
|
||||
<ActionLink
|
||||
onClick={() => 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={<LearnMoreIcon />}
|
||||
>
|
||||
{I18n.t('site_settings.webhooks.learn_more')}
|
||||
|
||||
@@ -81,14 +81,6 @@ const GenerateApiKeyDialog = ({
|
||||
</>
|
||||
}
|
||||
|
||||
<br /><br />
|
||||
<ActionLink
|
||||
icon={<LearnMoreIcon />}
|
||||
onClick={() => window.open('https://docs.astuto.io/api', '_blank')}
|
||||
>
|
||||
{I18n.t('common.forms.api_key.api_key_learn_more')}
|
||||
</ActionLink>
|
||||
|
||||
{ error && <DangerText>{error}</DangerText> }
|
||||
</>
|
||||
);
|
||||
|
||||
@@ -3,7 +3,7 @@ import I18n from 'i18n-js';
|
||||
|
||||
const PoweredByLink = () => (
|
||||
<div className="poweredBy">
|
||||
<a href={`http://astuto.io/?utm_campaign=poweredby&utm_source=${window.location.hostname}`} target="_blank">
|
||||
<a href="https://github.com/astuto/astuto/" target="_blank">
|
||||
{ I18n.t('common.powered_by') } Astuto
|
||||
</a>
|
||||
</div>
|
||||
|
||||
@@ -78,7 +78,7 @@
|
||||
</div>
|
||||
<% else %>
|
||||
<% if not Rails.application.multi_tenancy? %>
|
||||
<p>You have to <a href="https://docs.astuto.io/deploy-with-sidekiq">enable Sidekiq</a> to receive recap notifications.</p>
|
||||
<p>You have to <a href="https://github.com/astuto/astuto-docs/blob/main/docs/deploy/sidekiq.md">enable Sidekiq</a> to receive recap notifications.</p>
|
||||
<% end %>
|
||||
<% end %>
|
||||
|
||||
|
||||
@@ -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' %>
|
||||
|
||||
<div class="dropdown-divider"></div>
|
||||
|
||||
@@ -15,7 +15,7 @@ Dive into your new feedback space at <a href="<%= get_url_for(method(:root_url))
|
||||
</p>
|
||||
|
||||
<p>
|
||||
To customize your feedback space, just head to <a href="<%= get_url_for(method(:site_settings_general_url)) %>">site settings</a>. For more advanced configurations, such as custom OAuth providers or custom domains, you can refer to the <a href="https://docs.astuto.io/">Astuto documentation</a>.
|
||||
To customize your feedback space, just head to <a href="<%= get_url_for(method(:site_settings_general_url)) %>">site settings</a>. For more advanced configurations, such as custom OAuth providers or custom domains, you can refer to the <a href="https://github.com/astuto/astuto-docs">Astuto documentation</a>.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
|
||||
Reference in New Issue
Block a user