Documentação do Horse

[chambber]

(primeiramente desculpas, sei que o repositório está todo em Inglês, e estou escrevendo em Português)

Gostaria de parabenizar que esse projeto é fantástico, principalmente pela facilidade e simplicidade a que ele se propõe que me remete a algumas ferramentas em NodeJs que sinto falta em Delphi/Pascal, principalmente na área Web!

Agora, queria saber como eu poderia ajudar, não sou expert, mas tenho alguma experiência em Delphi, e nem que seja para criar uma documentação, uma home page. O que quero saber é, posso ajudá-los, e se sim, no quê?

[hunsche]

Boa noite nobre @chambber ,
Fico feliz que o projeto tenha despertado sua atenção, a essência do Horse foi claramente descrita no seu comentário.

Referente a documentação e home page, são alguns dos itens que estão no roadmap do Horse, assim que possível vamos criar um roadmap oficial aqui no github, onde vai facilitar a contribuição de pessoas interessadas.

Atualmente não temos ninguém desenvolvendo estes itens, se você quiser criar uma documentação e uma home page, vai ser de grande ajuda para a comunidade.

[chambber]

Decobri por acaso pois precisei acessei o template do gitignore do GitHub, e vi lá um gerenciador de dependências e todos os projetos relacionados aqui, e me chamou muita a atenção esse projeto.

Quanto a home page com a documentação, posso estar fazendo, em relação a esses itens, ferramentas a serem utilizadas, como pretendem fazer, tem algo em mente?

[hunsche]

Que legal, isso o gitignore.io já contempla a pasta modules do boss..

Referente a home page e a documentação, pensamos em usar o git pages.

[chambber]

Entendi, considerando isso, algo como um gerador estático, como docsify, ou até um hexo, algo desse tipo?

[hunsche]

Eu particularmente gosto muito da estrutura do hexo, mas gostaria de deixar livre a decisão de escolha para você.

[chambber]

Tudo bem, estarei usando o hexo para o projeto, estarei começando então.

[chambber]

Estou com o projeto inicial montado, dito isso queria discutir:

• O que acham?
• Pontos a serem abordados na documentação.
• Repositório para documentação.
• Internacionalização no mesmo repositório ou separado?
• Possibilidade de usar o Netlify.

[hunsche]

Muito bom @chambber,

Pensei em abordar alguns assuntos:

• Get Started
  • instalando o horse
  • iniciando seu servidor
• Methods HTTP
  • GET
  • PUT
  • DELETE
  • POST
• Requests
  • ParamID
  • QueryParam
  • Body
  • Headers
• Response
  • Send
  • StatusCode
  • Headers
• Avançados
  • Roteamento
  • Middlewares
    • Segurança
    • Sessões
    • Json
    • Log
  • Tools
    • Boss

Em relação a tradução e documentação podemos criar uma pasta /docs dentro do repositório principal do horse, mas é apenas uma sugestão, se você achar melhor criarmos um repositório a parte podemos faze-lo.

O Netlify, atenderia de maneira free as necessidades que você julga básicas?

Sugestões sempre são bem vindas.

[chambber]

Sobre o repositório estava pensando sobre a pasta /docs também, porém se fosse simplesmente os arquivos estáticos. Como terá um projeto inteiro com suas próprias dependências referentes ao hexo, isso me leva a pensar que seria melhor um a parte.

Quanto ao Netlify a ideia seria facilitar, configurando um continuous deployment que creio que facilitaria o fluxo de atualização da documentação. Portanto o gratuito já atenderia.

[hunsche]

Boa ideia,
Criamos um repositório específico para este projeto.

[chambber]

Sobre o andamento da tarefa:

• Implementei suporte a vários idiomas na documentação,
• Configurei a integração com o Netlify com redirecionamento de idioma e desenvolvimento contínuo no master.
  Nessa semana estarei finalizando a documentação seguindo os assuntos mencionados.

Quanto a documentação em inglês não tenho conhecimento suficiente para escrevê-la, mas estou preparando os arquivos para ficar fácil de serem traduzidos, tudo bem?

A documentação está usando um domínio gratuito por enquanto, não sei como pretendem fazer em relação a domínio.

[hunsche]

Muito bom,

A integração com o Netlify vai facilitar muito nossa vida em relação aos deploys e contribuições.

Referente a documentação em inglês, aconselho deixar tudo traduzido automaticamente pelo google translate, logo depois podemos ir ajustando a mesma para fazer mais sentido.

Hoje possuimos o dominio hashload.com, é possivel criarmos o dominio horse.hashload.com.

[chambber]

Certo, deixarei com tradução automática.

Sobre o domínio, tudo bem, estarei alterando para horse.hashload.com.

[hunsche]

Referente ao domínio, como posso configurar o apontamento?

[chambber]

A configuração de DNS seria as seguintes:

• dns1.p06.nsone.net
• dns2.p06.nsone.net
• dns3.p06.nsone.net
• dns4.p06.nsone.net

[hunsche]

DNS apontado.

[hunsche]

Boa tarde,
@chambber eu criei uma issue, para referenciar a documentação ao projeto principal, pois não tive tempo para fazer o mesmo.

Caso tenha disponibilidade, pensei em refazermos o README.MD para algo mais intuitivo e com mais informações.

[chambber]

Boa noite,
Semana corrida, não consegui te responder, desculpe-me.

Quanto a documentação estou escrevendo e também criando uma API de todos os métodos disponíveis.
Atualmente criei algumas aplicações para testar as funcionalidades para poder entender melhor e escrever sobre e queria confirmar algumas coisas:

• Os parâmetros não fazem validações de expressões regulares?
• Quando eu não quiser a continuação do próximo Callback, devo lançar uma exceção como por exemplo, EHorseCallbackInterrupted?

Quanto ao README tinha pensado sim, e posso sim.

[hunsche]

Bom dia, fica tranquilo sabemos bem como é ter a semana corrida 😉

Muito boa a ídeia de explorar a API exemplificando os métodos.

Referente às perguntas:

• Os parâmetros não fazem validações de expressões regulares? Atualmente não faz validação por regex, mas é uma excelente feature, podemos colocar no roadmap do horse, ainda em construção.

• Quando eu não quiser a continuação do próximo Callback, devo lançar uma exceção como por exemplo, EHorseCallbackInterrupted? Sim, hoje a parada do callback é forçada por esta exception.