Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Creative Common Technical Documentation Guideline page added #823

Conversation

Dev-JoyA
Copy link
Contributor

@Dev-JoyA Dev-JoyA commented Oct 7, 2024

Fixes

Description

This PR introduces a set of guidelines for writing and maintaining technical documentation. It aims to create a consistent style across the open-source contributors' site by including references to upstream style guides, defining CC-specific terminology, outlining Markdown usage and syntax preferences, and recommending resources for tech-writing and Markdown.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@Dev-JoyA Dev-JoyA requested review from a team as code owners October 7, 2024 13:18
@Dev-JoyA Dev-JoyA requested review from TimidRobot, possumbilities and dhruvkb and removed request for a team October 7, 2024 13:18
@Dev-JoyA Dev-JoyA changed the title Creative Common Technical Documentation Guideling blog added Creative Common Technical Documentation Guideline page added Oct 7, 2024
Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great start! Please see code comments

@TimidRobot TimidRobot self-assigned this Oct 7, 2024
@TimidRobot

This comment was marked as outdated.

@Dev-JoyA

This comment was marked as outdated.

Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please resolve requested changes before requesting re-review

@Dev-JoyA

This comment was marked as outdated.

@Dev-JoyA
Copy link
Contributor Author

Dev-JoyA commented Oct 8, 2024

Please resolve requested changes before requesting re-review

@TimidRobot I sincerely apologize it was an oversight

…ng code , added markdown to documentaion guideline
Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! good work!

@Dev-JoyA
Copy link
Contributor Author

Nice! good work!
@TimidRobot Thank you so much , and I am so sorry for stressing you on this PR

@TimidRobot TimidRobot merged commit c909c5f into creativecommons:main Oct 10, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

[Content] Add a Documentation Guidelines page
2 participants