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

Move all documentations and charters #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Move all documentations and charters #2

wants to merge 1 commit into from

Conversation

sheplu
Copy link
Member

@sheplu sheplu commented Feb 29, 2024

Move all charters and documents part of the Express repository in the Admin repository

The current list is comprised of

In the same time a PR in the Express repository will be opened to remove (or update and link) to this repository

I am not sure about how we want to order that in this repository, I added everything in a charters folder, but it may make sense to split that in

  • charters
  • contributing (or contribution)
  • processes (for security, triage...)

Copy link
Member

@UlisesGascon UlisesGascon left a comment

Choose a reason for hiding this comment

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

I think that Github offers a lot of advantages if we rename this repo to .github. I see that other orgs are using this, like fastify. That way we can inherit these files to other repos like security, CoC, contributing and so on... more info

@sheplu
Copy link
Member Author

sheplu commented Mar 1, 2024

yes, I was discussing that (and learned that) from Jordan yesterday - but this only work with specific files.
On our current list, only CoC/Contributing/Security would be "shared"

The main question being: Do we want to split the files between .github and Admin? Or do we want to put them in .github and if they are not propagated we just use a normal link (like we would do here in Admin)

Learning that, I was planning to open a PR inside for all issue and pr template (should be done today)

@UlisesGascon
Copy link
Member

The main question being: Do we want to split the files between .github and Admin? Or do we want to put them in .github and if they are not propagated we just use a normal link (like we would do here in Admin)

For simplicity I will keep it under one repository. That is what I do in other orgs.

Any document that is not shared by Github automatically I will add a reference to the .github/xxx.md. That is easy because we only need to edit things in one place.

@crandmck
Copy link
Member

crandmck commented Mar 5, 2024

The contents of Contributing.md, Collaborator-Guide.md, and Security.md are duplicated into https://github.com/expressjs/expressjs.com/blob/gh-pages/en/resources/contributing.md via the script at
https://github.com/expressjs/expressjs.com/blob/gh-pages/get-contributing.sh... And the page is published to https://expressjs.com/en/resources/contributing.html.

So get-contributing.sh will just need to be updated for the new file locations, then re-run, and the updated file committed to the expressjs.com repo. I think @jonchurch worked on that script, so perhaps he could take a stab at it. My "sed-fu" is extremely rusty, and my "bash-fu" is somewhat shaky, so I'm hesitant to do so.

@jonchurch
Copy link
Member

@UlisesGascon
I think that Github offers a lot of advantages if we rename this repo to .github. I see that other orgs are using this, like fastify. That way we can inherit these files to other repos like security, CoC, contributing and so on... more info

We do have https://github.com/expressjs/.github already, so we cannot rename this one.

I like the .github convention for this actually.

@sheplu
The main question being: Do we want to split the files between .github and Admin? Or do we want to put them in .github and if they are not propagated we just use a normal link (like we would do here in Admin)

One repo to rule them all.

That being said, these are convos for an issue. I don't have any edits to suggest for this PR in it's current state and think we can merge and carry on in an issue.

@wesleytodd
Copy link
Member

Multiple threads of this convo lol, and I just commented on the other one. I'm on my phone so lost it, but it's in the discussions one IIRC.

Basically I am 👍 on using .github and think we should at most rename the discussions repo not have a new one.

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.

None yet

5 participants