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

Add local contribution guide #69

Open
wants to merge 48 commits into
base: main
Choose a base branch
from
Open

Add local contribution guide #69

wants to merge 48 commits into from

Conversation

Cli4d
Copy link
Member

@Cli4d Cli4d commented Aug 11, 2023

I have created a simple draft that we can build upon to act as the local contribution guide. I've added towards the end of the contributing terms page since the information that comes before is important

Resolves OpenTermsArchive/template-declarations#32

@Cli4d Cli4d marked this pull request as draft August 11, 2023 16:00
@MattiSG
Copy link
Member

MattiSG commented Aug 28, 2023

@Cli4d I took a brief look at this draft, and it seems quite good already! What would you like to tackle before opening it for review? 🙂

@Cli4d
Copy link
Member Author

Cli4d commented Aug 29, 2023

I may have been overcomplicating it. Let me open it for review. We can add things based on feedback.

@Cli4d Cli4d marked this pull request as ready for review August 29, 2023 07:10
@Cli4d Cli4d requested a review from MattiSG August 29, 2023 07:10
Copy link
Member

@MattiSG MattiSG left a comment

Choose a reason for hiding this comment

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

Thank you @Cli4d!

The content is great, but the proposed location does not seem very appropriate to me: it splits the current document that, admittedly, is more a reference, right in the middle.

I would suggest to create a new, dedicated page called “contributing terms” with your content, and rename the existing one to “Declarations reference” or move it into a new group called “Reference” with a page called “Declaration”, just like there is currently a group called “Guidelines” with a page called “Targeting” 🙂
Let us know if you need any help in this!

content/contributing-terms.en.md Show resolved Hide resolved
content/contributing-terms.en.md Show resolved Hide resolved
content/contributing-terms.en.md Show resolved Hide resolved
content/contributing-terms.en.md Show resolved Hide resolved
content/contributing-terms.en.md Show resolved Hide resolved
content/contributing-terms.en.md Show resolved Hide resolved
content/contributing-terms.en.md Show resolved Hide resolved
content/contributing-terms.en.md Show resolved Hide resolved
@MattiSG MattiSG changed the title Add draft of local contribution guide Add local contribution guide Aug 29, 2023
Cli4d and others added 7 commits September 1, 2023 11:38
This is to stick with the business terms

Co-authored-by: Matti Schneider <[email protected]>
Made some minor edits for better readability

Co-authored-by: Matti Schneider <[email protected]>
Some grammar improvement for better readability

Co-authored-by: Matti Schneider <[email protected]>
Co-authored-by: Matti Schneider <[email protected]>
@MattiSG
Copy link
Member

MattiSG commented Sep 3, 2023

Please let me know when this PR is ready for review by using the “request review” feature 🙂

@netlify
Copy link

netlify bot commented Oct 3, 2023

Deploy Preview for open-terms-archive-docs ready!

Name Link
🔨 Latest commit 3ae5c07
🔍 Latest deploy log https://app.netlify.com/sites/open-terms-archive-docs/deploys/65c396a0926a35000889d4bd
😎 Deploy Preview https://deploy-preview-69--open-terms-archive-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@clementbiron clementbiron self-requested a review October 11, 2023 08:25
Copy link
Member

@MattiSG MattiSG left a comment

Choose a reason for hiding this comment

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

Thanks @Cli4d and @clementbiron!

I feel that there is still a tiny bit of work necessary before the value provided by this changeset in providing a simpler approach to contribution goes beyond the costs it has in splitting and having potentially redundant content.

Based on the live preview, I feel that this branch is not up to date. @clementbiron could you please make sure that the latest changes are integrated, probably through an upstream merge? I for example do not see the “Creating a collection” page.

content/contributing-terms.en.md Show resolved Hide resolved
content/contributing-terms.en.md Show resolved Hide resolved
content/contributing-terms.en.md Show resolved Hide resolved
content/contributing-terms.en.md Show resolved Hide resolved
content/contributing-terms.en.md Outdated Show resolved Hide resolved
content/reference/declaration.en.md Outdated Show resolved Hide resolved
content/reference/declaration.en.md Outdated Show resolved Hide resolved
@Cli4d Cli4d requested a review from MattiSG January 3, 2024 10:49
@Cli4d
Copy link
Member Author

Cli4d commented May 6, 2024

Just realized how important this documentation is important as I was trying to review the contributions to Kenya Declarations

I see there are some tests that failed again. Not sure why, I believe I had fixed everything before ending the 6-month program. However, I'll try to find and fix the broken links

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how to add terms locally
3 participants