Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Polishing, rough edges & flow improvement #1926

Closed
ljupcovangelski opened this issue Jun 4, 2021 · 2 comments
Closed

Docs: Polishing, rough edges & flow improvement #1926

ljupcovangelski opened this issue Jun 4, 2021 · 2 comments
Assignees
Labels

Comments

@ljupcovangelski
Copy link
Contributor

Configuration section:

  • Example airy.yaml

Sources:

  • Disclamer for the sources and the webhook that they are not enabled by default and that they need to be enabled.
  • On how to enable them - code blocks with example configuration, per source.

Installation:

  • When clicking on "Installation -> CLI", the green block "Deploy Airy core" leads back to Installation. Next step should be choose the provider (Instalation of the CLI should be separated from Minikube/AWS, either on a separate page or a separate block).
  • Logical path: Installation of the cli -> Install Airy (choose your provider) -> Secure your instance -> Quickstart -> Setup other sources (Sources->Introduction)

Security:

  • "Secure your instance" should link to the Authentication document (Perhaps that document should be moved outside of the "API" block and under "Setup & Deployment"
  • Remove the "Create a self-signed certificate" error. We assume that people have certificate and put in a link for Traefik and Let's encrypt
  • Add a disclamer for recommendation of HTTPS on AWS.

Chat plugin installation:

  • Update the code
@ljupcovangelski ljupcovangelski self-assigned this Jun 4, 2021
@ljupcovangelski ljupcovangelski added this to To do in Engineering WIP via automation Jun 4, 2021
@ljupcovangelski ljupcovangelski moved this from To do to In progress in Engineering WIP Jun 7, 2021
@AudreyKj
Copy link
Contributor

AudreyKj commented Jun 7, 2021

chat plugin:

installation code:

j.src = w[n].host + "/s.js"; must be fixed to j.src = w[n].host + '/chatplugin/ui/s.js';

ljupcovangelski added a commit that referenced this issue Jun 7, 2021
ljupcovangelski added a commit that referenced this issue Jun 7, 2021
ljupcovangelski added a commit that referenced this issue Jun 8, 2021
ljupcovangelski added a commit that referenced this issue Jun 8, 2021
ljupcovangelski added a commit that referenced this issue Jun 8, 2021
@ljupcovangelski
Copy link
Contributor Author

Done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Development

No branches or pull requests

2 participants