githubtraining / innersource Goto Github PK

Does the course meet the learning objectives listed in its description?

Yes to all but one.

Managing projects - without going to the changed file section, it was not immediately clear what actions I need to take to manage projects appropriately.

Brought up by @rkzm in https://github.com/github/services/issues/5632#issuecomment-484447068

Bug Report

Current behavior
The course links to a learning path on GitHub.com and not to the learning path on GHES when deployed on GHES.

Reproduction
Steps to reproduce the behavior in the course:

1. Finish the class successfully.
2. Click on 'Innersource learning path'
3. It opens up this site: https://lab.github.com/githubtraining/paths/innersource:-theory-to-practice

Expected behavior
I would expect that LL deployed on GHES would link to the learning paths in GHES and not to the ones on GitHub.com

Possible solution
Not sure if you use the same containers for GHES vs. GitHub.com, but it would be nice to have that link correct when deployed out to GHES if possible.

Additional context
I should be able to work around this locally. Pinged @crichID via Slack and requested someone also open up an issue against LL for including Learning Paths as a part of the deployment.

/cc @crichID @brianamarie @hectorsector @JasonEtco

Not focus too much on developers but the company as a whole. Anyone can use GitHub.

Brought up by @rkzm in https://github.com/github/services/issues/5632#issuecomment-484447068

Introduce the concept of enterprise accounts earlier in the course. See #23 (review) for more context.

Suggestion from @carolynshin:

maybe this is covered in the case study section but i would also want to know - ok i’m excited about innersource, i wanna do this, i’m learning about it but how do i get my colleagues excited about it?

Bug Report

Current behavior
Setup of the InnerSource fundamentals seems to be broken.

Reproduction
Steps to reproduce the behavior in the course:

1. Go to https://lab.github.com/githubtraining/innersource-fundamentals
2. Click on Install
3. Create new public repository.
4. Click on the "Start Next Step" action button.
5. Navigates to Jamie-Clayton/innersource#1 which doesn't exist in the repository created.

Expected behavior
https://github.com/JenasysDesign/innersource/issues should be populated. OR
Innersource repository should include instructions on how to address the missing issues.

Possible solution
Attempted to run https://lab.github.com/install?owner=githubtraining&course=innersource-fundamentals to see if that resolved the issue, but it failed.

Bug Report

Current behavior
For "2. Answer the ownership challenge", response says that githubtraining/training-manual is private while currently the actual repo is public.

Reproduction
Steps to reproduce the behavior in the course:

1. Go to https://lab.github.com/githubtraining/innersource-fundamentals
2. Click on starting courses, and do step 2
3. See the differences by finding on actual repo url: https://lab.github.com/githubtraining/innersource-fundamentals

Expected behavior
Should be consistent - whether response says that the repo is public, or the actual repo needs to be changed as private.

Possible solution
(Applying to expected behavior)

Additional context
Impacts on GitHub - Learning Lab on InnerSource Fundamentals

can you rename all instances of Innersource to InnerSource? it's a standard the community is attempting to standardize on and my belief is that this could help. Up to you though!

Reported by @brntbeer in https://github.com/github/services/issues/5632#issuecomment-483985228

In step 5, when the discussion is around CODEOWNERS can we link to https://help.github.com/en/articles/about-code-owners?

Brought up by @garman in https://github.com/github/services/issues/5632#issuecomment-484183135

I ❤️ ❤️ ❤️ this course, especially the creative use of checkboxes. 🔮

I wonder, could the first step of introducing the course happen, and then the first activity of clicking a checkbox be combined? I don't know if a lot of value is added by closing an issue as a first step.

Initial error message found: brianamarie/innersource#6

#### This issue is used for debugging errors thrown during a course.

---

* Node.js Version: `v10.16.3`
* Node.js Env: `production`
* Git SHA: `53dccff264e8d8d6bf51523c183e511a1b873da1`
* Git Branch: `improve-api-docs`

---

###### Seeing a problem? Open an issue [in the course repository](https://github.com/githubtraining/innersource/issues/new).

Error in innersource-fundamentals:answer-the-workflows-challenge-question:removeBranchProtection[0]

HttpError: {"message":"Branch not protected","documentation_url":"https://developer.github.com/v3/repos/branches/#remove-branch-protection"}
    at response.text.then.message (/app/node_modules/@octokit/rest/lib/request/request.js:72:19)
    at process._tickCallback (internal/process/next_tick.js:68:7)

cc @hectorsector

In step 2 as part of the "Why can't you see it then," there is a phrase "Collapse this text..." Should it be "Expand this text..." as the little arrow/text is collapsed when the comment is added.

Brought up by @garman in https://github.com/github/services/issues/5632#issuecomment-484183135

Step 3/7 didn't require a review, while the other PRs did, not sure if thats anything, but figured I'd call it out.

Brought up by @garman in https://github.com/github/services/issues/5632#issuecomment-484183135

Hi @hectorsector 👋 I've put together this list of types of things we'd want templates or examples for. Does this look right?

Discoverable repos

Q: For this section, I think these are good tips, but the come from all over. I wonder if for this section, it makes more sense to provide this list of tips instead of pointing to other resources?

• If you have a blog and mailing list, utilize it. Once your repo is ready, send an announcement email to all your subscribers.
• Share it on relevant internal networks. Invite people to check out your website and GitHub repo.
• Reach out to others who keep interest in your work area and see if they can proactively communicate about your repo.
• Tell users to star your repo if they find it interesting.
• Make sure you solve a real problem
• Make sure your idea behind the solution, your vision is clearly written down.
• Find some enthusiastic early adopters
• Add a short, but clear description of what the program does
• Add other common README sections: contributing, build instructions, short usage example, gitter badge, etc.
• Add a screenshot of the program. Without a screenshot, visitors are more likely to bounce (SEO term)
• Create a demo page if possible.
• Promote the repository yourself using media channels.
• Add a logo to the top of your README

Specific files

• Make a README.md, awesome README.mds
• Issue & PR templates
• Contributing guides
• .gitignore
• protected branches settings
• General collaboration best practices

Branching strategies

• Nice guide about branching strategies
• Maybe contributing guides belong here since it applies about communicating branching strategies?

Project management

• Q: What are we trying to teach here? What are the goals for this step?

Measuring success

• Q: This is another one - are there good resources out there, or would it make more sense for us to give more strategic advice that it's important to think about what success means to them, and have clear goals before getting started with any of the above steps, including a plan on how to measure?

Right now, after the user checks a box, the bot comments with a response, closes the issue, and comments again. I think it would make sense to combine those comments. cc @hectorsector

Bug Report

Incorrect url in
innersource / responses / 14_congratulations.md
line 17
https://github.com/githubtraining/paths/innersource:-theory-to-practice
the correct url is
https://lab.github.com/githubtraining/innersource:-theory-to-practice

Currently, I'm able to merge at every step of the process. This issue is a reminder to put in branch protections in pull requests so that the user doesn't merge too early. cc @hectorsector

I thought it would be cool to turn some or all of the screenshots into animated gifs for clarity and to add some fun activity to the content. If you like this approach, @hectorsector, I can make some more. Didn't want to convert all of them if you didn't like it.

For example, I created a gif for the below image:

Animated Gif