Licencing this repo

Abierto
  • ¿Algo no está bien?
#83 4 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Área
documentation

Línea de trabajo

Start by reviewing the website's existing @include usage and the original and altered .md documentation files. Add the stated CC BY-SA 3.0 attribution where the issue describes, create the new LICENCE.md attribution, and verify that both the website and markdown files display the required notices.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Have you checked for existing feature requests?
  • Completed
Summary

So we do have a small issue, whilst Atom itself was licenced under MIT the documentation for the website (i.e. the atom/flight-manual.atom.io repo) is actually licenced under CC BY-SA 3.0.

This means we need to provide attribution to this documentation in a bunch of places to remain clean on this.

  • The website itself needs to have attribution when displaying the original docs, maybe just a single separate attribution file we can @include in each section.
    • e.g. "Atom flight-manual" by GitHub is licensed under CC BY-SA 3.0
  • Each original .md file can have the same attribution as above but probably just with an html comment at the bottom
    • e.g. <!--"Atom flight-manual" by GitHub is licensed under CC BY-SA 3.0-->
  • We will need a new LICENCE.md file in this repo which will have to pay attribution to the original licence:
    • e.g. "Pulsar", is a derivative of [Atom Flight Manual](https://flight-manual.atom.io) by GitHub, used under CC BY-SA 3.0. "Pulsar" is licensed under CC BY-SA 4.0 by [Pulsar-edit](https://github.com/pulsar-edit).
  • Any altered documentation (I imagine just the actual content rather than the html stuff) will need also need to be displayed on the website as well as within the .md files like the unaltered stuff with the above (or similar) wording. We can just use @includes for the sections and html comments again for the md files.
Enter your response below:

We wont get in trouble

Any alternatives?

Re-write everything from scratch and throw the old docs away

Other examples:

No response

Lenguaje dominante
EJS
Estrellas
31
Forks
33
Merge medio
2 min
PR fusionados (30 d)
2

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de pulsar-edit/pulsar-edit.github.io

Todos los issues de pulsar-edit/pulsar-edit.github.io

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.