Licencing this repo

オープン
  • 何か問題がありますか？
#83 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
領域
documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
EJS
スター
31
フォーク
33
平均マージ
2分
マージ済み PR（30日）
2

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

pulsar-edit/pulsar-edit.github.io のほかの issue

pulsar-edit/pulsar-edit.github.io の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。