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

doc: move streaming instructions to doc/contributing #45582

Closed
wants to merge 4 commits into from

Conversation

mhdawson
Copy link
Member

  • make streaming instructions more discoverable by moving them from the TSC repo to doc/contributing
  • upate the instructions to reflect current practice

Signed-off-by: Michael Dawson mdawson@devrus.com

- make streaming instructions more discoverable by
  moving them from the TSC repo to doc/contributing
- upate the instructions to reflect current practice

Signed-off-by: Michael Dawson <mdawson@devrus.com>
@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Nov 22, 2022
@mhdawson
Copy link
Member Author

I'l remove the copy in the TSC repo once this lands.

@richardlau
Copy link
Member

  • make streaming instructions more discoverable by moving them from the TSC repo to doc/contributing

It doesn't really feel like these belong here though. Most contributors will not be streaming on the project's accounts (nor have access to do so).

@mhdawson
Copy link
Member Author

@richardlau the leads for the teams are the people that I've been most recently sharing with. I guess they are not necessarily in core, but I thought this would be more discoverable that anywhere else we have.

@richardlau
Copy link
Member

If discovery is the issue, perhaps a link could be added to the meeting templates for the meeting hosts?

@mhdawson
Copy link
Member Author

@richardlau I'm not sure I understand what you mean by:

If discovery is the issue, perhaps a link could be added to the meeting templates for the meeting hosts?

do you mean add a link to the meeting templates in this doc and a section about setting up the meeting generation?

@richardlau
Copy link
Member

@richardlau I'm not sure I understand what you mean by:

If discovery is the issue, perhaps a link could be added to the meeting templates for the meeting hosts?

do you mean add a link to the meeting templates in this doc and a section about setting up the meeting generation?

I mean the meeting templates could contain a section for meeting hosts that points to the doc in the TSC repo. That way every generated meeting issue would contain a link to the streaming instructions.

@mhdawson
Copy link
Member Author

I mean the meeting templates could contain a section for meeting hosts that points to the doc in the TSC repo. That way every generated meeting issue would contain a link to the streaming instructions.

I'm not sure if that would have helped in the recent cases where I shared the info. I guess it's also not necessarily directly related to where the doc is as it would still need to be somewhere for the link to point to. I don't think the TSC repo is the right place which is why I was moving it.

If you don't think docs/contributing is the right place where do you think it should be?

@richardlau
Copy link
Member

I don't think the TSC repo is the right place which is why I was moving it.

If you don't think docs/contributing is the right place where do you think it should be?

I think the TSC repo is a better fit for the streaming instructions than the core nodejs/node repo. If not the TSC repo, maybe https://github.com/nodejs/admin since that's where you need to open an issue to request access?

@mhdawson
Copy link
Member Author

I don't think people go looking in the TSC repo or the admin repo info like this, but if others disagree I'll close the PR. Going to leave this open for a bit to see if we get others chiming in as well.

@richardlau
Copy link
Member

While I don't think this repository is the place for the streaming instructions, I do not feel strongly enough about this to block PR from landing if there is otherwise consensus.

@Trott
Copy link
Member

Trott commented Nov 22, 2022

I agree with Richard that this is not the repository for these instructions, but I'm not readily coming up with a better place. If we still had a wiki on this repo, that might be OK. Maybe the thing to do is leave the instructions where they are but add a doc here that links to it?

Like Richard, I don't care enough to block this, so this can certainly land. It does feel like it's a misuse of the repository, though.

(I think we turned off the wiki because it was world-writable and nobody was paying attention to it and bad stuff was happening there. However, I'm pretty sure you can enable a wiki with write access for collaborators only. So maybe this is an indication that we should do that. I think there are a lot of things that would be better placed in the wiki, such as the onboarding/offboarding documentation, the glossary file, and probably everything or nearly everything under doc/contributing as long as we put a prominent link in the README and CONTRIBUTING.md.)

Copy link
Member

@gireeshpunathil gireeshpunathil left a comment

Choose a reason for hiding this comment

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

I see already documents in this folder which are relevant only to a subset of contributors: collaborator guide, offboarding, security on/off boarding etc. In the absence of a better place for this, and not seeing any downside of having this info here, I am good with its location.

doc/contributing/streaming-to-youtube.md Outdated Show resolved Hide resolved
mhdawson and others added 2 commits November 23, 2022 15:36
Co-authored-by: Gireesh Punathil <gpunathi@in.ibm.com>
mhdawson added a commit that referenced this pull request Dec 1, 2022
- make streaming instructions more discoverable by
  moving them from the TSC repo to doc/contributing
- upate the instructions to reflect current practice

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #45582
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
@mhdawson
Copy link
Member Author

mhdawson commented Dec 1, 2022

Landed in f2c4fe9

@mhdawson mhdawson closed this Dec 1, 2022
targos pushed a commit that referenced this pull request Dec 12, 2022
- make streaming instructions more discoverable by
  moving them from the TSC repo to doc/contributing
- upate the instructions to reflect current practice

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #45582
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
danielleadams pushed a commit that referenced this pull request Dec 30, 2022
- make streaming instructions more discoverable by
  moving them from the TSC repo to doc/contributing
- upate the instructions to reflect current practice

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #45582
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
danielleadams pushed a commit that referenced this pull request Dec 30, 2022
- make streaming instructions more discoverable by
  moving them from the TSC repo to doc/contributing
- upate the instructions to reflect current practice

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #45582
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
danielleadams pushed a commit that referenced this pull request Jan 3, 2023
- make streaming instructions more discoverable by
  moving them from the TSC repo to doc/contributing
- upate the instructions to reflect current practice

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #45582
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
danielleadams pushed a commit that referenced this pull request Jan 4, 2023
- make streaming instructions more discoverable by
  moving them from the TSC repo to doc/contributing
- upate the instructions to reflect current practice

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #45582
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
danielleadams pushed a commit that referenced this pull request Jan 5, 2023
- make streaming instructions more discoverable by
  moving them from the TSC repo to doc/contributing
- upate the instructions to reflect current practice

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #45582
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants