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

[readthedocs] Documentation [v0.4.3/v0.5.0] #1473

Closed
36 tasks done
mprevide opened this issue May 22, 2020 · 1 comment
Closed
36 tasks done

[readthedocs] Documentation [v0.4.3/v0.5.0] #1473

mprevide opened this issue May 22, 2020 · 1 comment
Labels
Team:Backend Related to platform backend Team:Frontend Related to platform frontend (GUI) Team:Security Related to platform security Type:Documentation Related to documentation activities (fix, update ...)

Comments

@mprevide
Copy link
Contributor

mprevide commented May 22, 2020

  • Alguns pontos são sugestões a serem discutidas.
  • Podem faltar pontos a serem adicionados, atualizados ou complementados, adicione- os, altere-os ou delete-os.
  • Revisar também inclui verificar tradução

v0.4.3

Tutorials

  • Using flow builder,
    • Dojot nodes
      • Add nós cron, cron-batch, soma cumulativa e mesclar data @mprevide
    • Learn by examples
      • Adicionar um exemplo com cumulative sum (contexto), switch and notification node @mprevide

Outros pontos:

v0.5.x

  • Architecture
    • Adicionar kafka-ws.. @jonaphael
    • Adicionar kafka2ftp.. @mprevide
    • Adicionar mais informação sobre x509-identity-mgmt (Acredito que pode-se ter um novo item na raiz, uma nova página dedicada somente a isso, como em 2. IoT Agent architecture, e aqui fazer apenas um resumo pequeno do x509-identity-mgmt) @thiagodpf
    • Revisar @mprevide
  • IoT Agent architecture
  • Concepts
  • Components and APIs
    • Adicionar documentação das apis de novos serviços /Atualizar Exposed APIs (kafkaws) @jonaphael
    • Adicionar documentação da api (gui-v2)/Atualizar Exposed APIs (Se for abrir o código)
    • Adicionar documentação das apis de novos serviços / Atualizar Exposed APIs (x509-identity-mgmt) @thiagodpf
    • Revisar
  • Internal communication
  • Installation Guide
    • Compose
      • SUGESTÃO: Comentar que os volumes são habilitados por default (talvez falar q pode usar o down -v )
    • Kubernetes
      • Atualizar (como subir, versao do k8s, HaProxy)
  • Frequently Asked Questions
  • Release history
    • Criar release para defendu

Tutorials

  • Using web interface

    • Device management
    • Novo item explicando o novo relatório (falar ql algoritmo é usado) @wellitonSouza (AINDA FALTA SUBIR O VÌDEO)
    • Novo item explicando geração de certificados @wellitonSouza (AINDA FALTA SUBIR O VÌDEO)
    • Novo item explicando dashboard (Se for abrir o código) (AINDA FALTA SUBIR O VÌDEO)
    • Trocar imagens em atenção para screenshots da gui atual
    • Falar que só é possivel gerar cert pela gui se estiver no localhost ou com https
    • Revisar
  • Using API interface

    • Sending messages
    • Revisar
  • Using flow builder,

Outros pontos:

Obs.: Tudo que for feito deve ser traduzido.
Obs. 2: Não esquecer de alterar informações de versão como em clones, links, etc.

@mprevide mprevide changed the title [readthedocs] Documentation [development (v0.5.0-alpha)] [readthedocs] Documentation [v0.4.3 / v0.5.0-alpha] Jul 1, 2020
@mprevide mprevide added the Type:Documentation Related to documentation activities (fix, update ...) label Jul 1, 2020
@mprevide mprevide changed the title [readthedocs] Documentation [v0.4.3 / v0.5.0-alpha] [readthedocs] Documentation [v0.4.3/v0.5.0-alpha] Jul 3, 2020
@mprevide mprevide self-assigned this Jul 29, 2020
@mprevide mprevide added Team:Backend Related to platform backend Team:Frontend Related to platform frontend (GUI) Team:Security Related to platform security labels Jul 29, 2020
@mprevide mprevide changed the title [readthedocs] Documentation [v0.4.3/v0.5.0-alpha] [readthedocs] Documentation [v0.4.3/v0.5.0] Jul 30, 2020
This was referenced Aug 4, 2020
@mprevide mprevide removed their assignment Aug 5, 2020
@mprevide mprevide self-assigned this Aug 18, 2020
@mprevide mprevide assigned mprevide and unassigned mprevide Aug 20, 2020
@mprevide mprevide removed their assignment Sep 29, 2020
@bizetti
Copy link
Contributor

bizetti commented Jan 18, 2021

Released with the dojot versions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Backend Related to platform backend Team:Frontend Related to platform frontend (GUI) Team:Security Related to platform security Type:Documentation Related to documentation activities (fix, update ...)
Projects
None yet
Development

No branches or pull requests

2 participants