Document that v1 and v2 contexts don't work as-is in JSON-LD processors

Aberta Para iniciantes
#141 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
70/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Ativa
Domínio
documentation

Direção de pesquisa

Encontre a documentação que explica o uso dos contextos v1 e v2 e, em seguida, leia como ela descreve atualmente o processamento de documentos JSON-LD. Documente que os processadores devem armazenar em cache uma cópia do contexto como solução alternativa para o problema de negociação de conteúdo do DOI; o trabalho estará concluído quando os leitores puderem encontrar essa orientação e entender por que o armazenamento em cache é recomendado.

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

Descrição

content

As noted by @notactuallyfinn in https://github.com/codemeta/codemeta/issues/500 , the v1 and v2 contexts cannot be fetched by JSON-LD processors because of the DOI's content negotiation issues.

The workaround is for software processing JSON-LD documents to have a cached copy of the context (which they should regardless, it's a good practice both for reliability and reproducibility). We should document this.

Linguagem predominante
CSS
Estrelas
5
Forks
23
Métricas de merge de PRs
Nenhum PR com merge em 30d

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de codemeta/codemeta.github.io

Todas as issues de codemeta/codemeta.github.io

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

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