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

docs: adding notes for developers on prod deploy, licensing, and minor corrections #198

Merged
merged 3 commits into from
Jul 9, 2021

Conversation

mattxwang
Copy link
Contributor

@mattxwang mattxwang commented Jul 7, 2021

I want to preface this by saying that I'm planning on rescoping #187 and adding a follow-up issue.

In this PR, I address parts of the original spirit of #187:

  • documenting the prod CD pipeline
  • updating relevant portions of the docs to be more correct
  • adding a licensing/attribution section
  • adds TOC

I want to move the discussion around Next.js, as well as the general design choices, to a project design document not unlike the one for Creative Lab's website. More in #202.

closes #187.

@mattxwang mattxwang marked this pull request as draft July 7, 2021 17:12
@mattxwang
Copy link
Contributor Author

mattxwang commented Jul 7, 2021

Eventually, I'd love to see us write something like this DESIGN_GUIDELINES for the Creative Labs website!

In the span of a minute or so, I'm going to make an executive decision and say that we should make a design guidelines doc. I'll rescope #187 and submit a follow-up issue; that means that this PR is technically ready to merge.

@mattxwang mattxwang marked this pull request as ready for review July 7, 2021 21:19
@mattxwang mattxwang changed the title docs: adding notes for developers on prod deploy, file structure, next.js quirks, and licensing docs: adding notes for developers on prod deploy and licensing Jul 7, 2021
@mattxwang mattxwang changed the title docs: adding notes for developers on prod deploy and licensing docs: adding notes for developers on prod deploy, licensing, and minor corrections Jul 7, 2021
@mattxwang mattxwang requested a review from a team July 7, 2021 21:27
Copy link
Member

@evanzhong evanzhong left a comment

Choose a reason for hiding this comment

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

lgtm.

Quickly scanned through the MPL and curious why you think it's a good fit

@mattxwang
Copy link
Contributor Author

Quickly scanned through the MPL and curious why you think it's a good fit

I didn't make the decision! Nikhil Kansal chose it when he made the repo about four years ago, and I'm extremely wary of relicensing code unless it's absolutely needed. Also, I think a more aggressive copyleft license is probably fine for our use-case, I can't imagine it's too restrictive given the general nature of our codebase (not much reusability).

That being said, open to discussion re: this point - this is a good time to change the license if any.

@evanzhong
Copy link
Member

Quickly scanned through the MPL and curious why you think it's a good fit

I didn't make the decision! Nikhil Kansal chose it when he made the repo about four years ago, and I'm extremely wary of relicensing code unless it's absolutely needed. Also, I think a more aggressive copyleft license is probably fine for our use-case, I can't imagine it's too restrictive given the general nature of our codebase (not much reusability).

That being said, open to discussion re: this point - this is a good time to change the license if any.

Personally I think a more aggressive copyleft is appropriate; our branding is unique and out website reflects that. I hear you about not wanting to relicense code though.

@mattxwang
Copy link
Contributor Author

Wrapped up our license convo offline; looks like we'll merge!

@mattxwang mattxwang merged commit 9dcb2c1 into main Jul 9, 2021
@mattxwang mattxwang deleted the next-docs-update branch July 9, 2021 01:01
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 CI/CD and Next.js quirks
2 participants