freeCodeCamp / freeCodeCamp/devdocs

Add Microsoft Documentation

Aberta
#2,159 2 comentários 11 reações 0 responsáveis Ver no GitHub
docs/new+request
Linguagem predominante
Ruby
Estrelas
39.5k
Forks
2.6k
Merge médio
4d 32min
PRs com merge (30d)
13

Descrição

# Feature request

## Summary

Please add the documentation from the following Microsoft sources listed below (more or less in order of importance), or as much as possible from it.

The existing search for these docs is lacking and an index doesn't exist. The offline version of the docs is _huge_, broken, unmaintained, and the search and index don't work either.
Furthermore, it would be convenient to have a single source for this documentation and other documentation DevDocs currently hosts (e.g. cppreference for which DevDocs also gives a superior search and index to what cppreference provides).

- https://github.com/MicrosoftDocs/windows-driver-docs
- https://github.com/MicrosoftDocs/windows-driver-docs-ddi
- https://github.com/MicrosoftDocs/sdk-api/
- https://github.com/MicrosoftDocs/win32
- https://github.com/MicrosoftDocs/cpp-docs
- https://github.com/MicrosoftDocs/windows-dev-docs
- https://github.com/MicrosoftDocs/winrt-api
- https://github.com/MicrosoftDocs/winrt-related
- https://github.com/MicrosoftDocs/Console-Docs
- https://github.com/MicrosoftDocs/windowsserverdocs
- https://github.com/MicrosoftDocs/PowerShell-Docs
- https://github.com/MicrosoftDocs/windows-powershell-docs
- https://github.com/MicrosoftDocs/Virtualization-Documentation
- https://github.com/MicrosoftDocs/windows-itpro-docs/
- https://github.com/MicrosoftDocs/visualstudio-docs

You could also add documentation from other repositories under https://github.com/MicrosoftDocs, such as:
- https://github.com/MicrosoftDocs/WSL/
- https://github.com/MicrosoftDocs/msix-docs/

The license for the documentation in all of those sources is [CC-BY-4.0](https://github.com/MicrosoftDocs/windows-driver-docs/blob/staging/LICENSE) which allows modification and distribution according to my understanding. The license for the code samples in the documentation is [MIT](https://github.com/MicrosoftDocs/windows-driver-docs/blob/staging/LICENSE-CODE).

### References

- https://github.com/freeCodeCamp/devdocs/issues/158
Says the license is incompatible, but old - from 2015. The license now allows modification and distribution.
- https://github.com/freeCodeCamp/devdocs/issues/2102
New but unclear. Says the the "docs need to be available under a free license". I don't know what you consider free, but CC-BY-4.0 looks "free enough" to me. The cppreference docs you provide are licenses under CC-BY-SA-3.0 which is more restrictive, so I gather CC-BY-4.0 is good enough.
- https://trello.com/c/PVnfdeaN
Says that "most docs by Apple / Microsoft / Adobe, are released under restrictive licenses (no redistribution) incompatible with DevDocs", but again this is not the case with regard to the Microsoft documentation listed above.

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Revise os repositórios MicrosoftDocs listados na issue, começando por windows-driver-docs e seus arquivos LICENSE e LICENSE-CODE, e depois compare o contexto existente do DevDocs nas issues #158 e #2102. O trabalho estará concluído quando houver um conjunto de fontes delimitado e for confirmado o suporte à importação da documentação, ao comportamento de pesquisa e indexação e ao licenciamento de redistribuição.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Domínio
documentation, search
Tipo de issue
Funcionalidade
Dificuldade
5/5
Tempo estimado
Mais de uma semana
Status de atividade
Estagnada
Clareza
Precisa de esclarecimento
Facilidade para iniciantes
25/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.