Licencing this repo

Đang mở
#83 4 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
EJS
Star
31
Fork
33
Merge trung bình
2 phút
Pull request đã merge (30 ngày)
2

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của pulsar-edit/pulsar-edit.github.io

Tất cả issue của pulsar-edit/pulsar-edit.github.io

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.