diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index a8e70a0b4..d79cdf3cc 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,32 +1,39 @@ ## Overview -**TL;DR** - -### Extra Detail + +### Extra detail + + #### Screenshots - + + #### Reasoning - - -### How to Contribute -- [ ] Comment on this issue if you'd like to work/collaborate on it! -- [ ] Fork the [repository](https://github.com/github/training-kit). -- [ ] Use the [GitHub Flow](https://guides.github.com/introduction/flow/) to make changes to your fork. [This](https://services.github.com/on-demand/intro-to-github/) is a refresher course if you're unsure about how to make a change on GitHub. -- [ ] Push your changes to your repository. -- [ ] Submit a Pull Request + + + +### How to contribute + +- Comment on this issue if you'd like to work/collaborate on it! +- Fork the [repository](https://github.com/github/training-kit). +- Use the [GitHub Flow](https://guides.github.com/introduction/flow/) to make changes to your fork. [This](https://github.com/skills/introduction-to-github) is a refresher course if you're unsure about how to make a change on GitHub. +- Push your changes to your repository. +- Submit a Pull Request - Base Dropdown: github/training-kit - Compare Dropdown: Your fork -#### Testing Locally +#### Testing locally + If you'd like to make and test changes locally (and see how they would look if merged), do the following: + - In your command line: - [Install Git](https://git-scm.com/) - [Install Ruby](https://www.ruby-lang.org/en/documentation/installation/) - [ ] Run `script/setup` - [ ] Run `script/server`. - - When successful, the script will initiate a local server at `http://127.0.0.1:4000/on-demand`. + - When successful, the script will initiate a local server at `http://127.0.0.1:4000/`. ### Questions? -- Leave a comment on this issue! Make sure to use @ mentions if you want a specific person's attention! + +- Leave a comment on this issue! Make sure to use `@mentions` if you want a specific person's attention! diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index aebe841f8..c41186e96 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,14 +1,19 @@ ## Overview -**TL;DR** - - + -### Next Steps - +## Questions -### Review - + + +## Next steps + + + +## Review + + diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 000000000..3591317b1 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,17 @@ +# Please see the documentation for all configuration options: +# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file + +version: 2 +updates: + + # Maintain dependencies for GitHub Actions + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "monthly" + + # Maintain dependencies for Bundler + - package-ecosystem: "bundler" + directory: "/" + schedule: + interval: "monthly" diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 000000000..6ec816d16 --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,61 @@ +name: "CodeQL" + +on: + push: + branches: [ "main" ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ "main" ] + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'ruby' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] + # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + + # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs + # queries: security-extended,security-and-quality + + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v2 + + # ℹ️ Command-line programs to run using the OS shell. + # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun + + # If the Autobuild fails above, remove it and uncomment the following three lines. + # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. + + # - run: | + # echo "Run, Build Application using script" + # ./location_of_script_within_repo/buildscript.sh + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 + with: + category: "/language:${{matrix.language}}" diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml new file mode 100644 index 000000000..fe461b424 --- /dev/null +++ b/.github/workflows/dependency-review.yml @@ -0,0 +1,20 @@ +# Dependency Review Action +# +# This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging. +# +# Source repository: https://github.com/actions/dependency-review-action +# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement +name: 'Dependency Review' +on: [pull_request] + +permissions: + contents: read + +jobs: + dependency-review: + runs-on: ubuntu-latest + steps: + - name: 'Checkout Repository' + uses: actions/checkout@v3 + - name: 'Dependency Review' + uses: actions/dependency-review-action@v2 diff --git a/.github/workflows/jekyll.yml b/.github/workflows/jekyll.yml new file mode 100644 index 000000000..8c9116eec --- /dev/null +++ b/.github/workflows/jekyll.yml @@ -0,0 +1,73 @@ +name: Deploy Jekyll site to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["main"] + # Runs on pull requests targeting the default branch + pull_request: + branches: [ "main" ] + + # Allows us to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow one concurrent deployment +concurrency: + group: "pages" + cancel-in-progress: true + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up Node + uses: actions/setup-node@v3 + with: + node-version: 16 + cache: 'npm' + - name: Install node modules + run: npm install + - name: Set up Ruby + uses: ruby/setup-ruby@ece82769428359c077b5a5eaff268902a303c101 + with: + bundler-cache: true # runs 'bundle install' and caches installed gems automatically + - name: Set up Pages + id: pages + uses: actions/configure-pages@v2 + - name: Build and test with Rake + # Only run in pull requests + if: github.event_name == 'pull_request' + run: bundle exec rake + - name: Build with Jekyll + # Don't run in pull requests + if: github.event_name != 'pull_request' + # Outputs to the './_site' directory by default + run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" + env: + JEKYLL_ENV: production + - name: Upload artifact + # Automatically uploads an artifact from the './_site' directory by default + uses: actions/upload-pages-artifact@v1 + + # Deployment job + deploy: + # Only run on pushes to the default branch + if: github.event_name == 'push' && github.ref == 'refs/heads/main' + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 diff --git a/.gitignore b/.gitignore index 19e3301bf..cd292a85a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,7 @@ _site/ .DS_Store /.rbenv-version -/vendor/gems/ +/vendor/ /bin/ /.bundle/ .sass-cache/ @@ -9,4 +9,5 @@ _site/ _release *.map .jekyll-metadata +node_modules/ # *.resume-burger-jokes diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index 2c1a03e59..000000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "_javascript/jquery-scrollsnap-plugin"] - path = _javascript/jquery-scrollsnap-plugin - url = https://github.com/benoitpointet/jquery-scrollsnap-plugin.git diff --git a/.ruby-version b/.ruby-version new file mode 100644 index 000000000..ef538c281 --- /dev/null +++ b/.ruby-version @@ -0,0 +1 @@ +3.1.2 diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 048a849e9..000000000 --- a/.travis.yml +++ /dev/null @@ -1,5 +0,0 @@ -language: ruby -rvm: - - 2.3.1 -script: - - script/cibuild diff --git a/CNAME b/CNAME new file mode 100644 index 000000000..91e8be9b2 --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +training.github.com \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index b390166bd..8439872c6 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -2,7 +2,7 @@ ## Our Pledge -In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. ## Our Standards diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f0a28aa5..1234ee022 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,77 +1,53 @@ # Contributing to training-kit -:tada: Thank you for taking the time to contribute and for seeking out these instructions. We :heart: community contributions to these materials. +🎉 Thank you for taking the time to contribute and for seeking out these instructions. We :heart: community contributions to these materials. -### Table of Contents - -[Code of Conduct](#code-of-conduct) - -[I just want to see the published resources!](https://services.github.com/on-demand/) - -[What should I know before I contribute?](#what-should-i-know-before-i-contribute?) -- [The goal of these resources](#the-goal-of-these-resources) -- [Types of contributions we love](#types-of-contributions-we-love) - -[How to contribute](#how-to-contribute) -- [Report a bug](#report-a-bug) -- [Translate existing resources](#translate-existing-resources) -- [Contribute a new resource or course](#contribute-a-new-resource-or-course) -- [Not sure where to start?](#not-sure-where-to-start?) - -[Step-by-step contribution guide](#step-by-step-contribution-guide) -- [Our content philosophy](#our-content-philosophy) -- [Content structure](#content-structure) -- [Writing new content](#writing-new-content) -- [Styling content](#styling-content) -- [Building and testing](#building-and-testing) - -
+--- ## Code of Conduct This project and everyone who participates in it is governed by the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [services@github.com](mailto:services@github.com). -
+--- ## What should I know before I get started? ### The goal of these resources -These materials are designed to help those new to Git, GitHub and software development as a whole. By using these resources, we hope users will: +These materials are designed to help those new to Git, GitHub and software development as a whole. By using these materials, we hope users will: - Feel welcome and become active contributors in the open source community -- Complete hands-on activities and receive immediate support from [Teacherbot](https://github.com/teacher-bot/teacherbot), members of the community, and [GitHub's Training team](community.md/#github-trainers) -- Learn best practices for using Git, GitHub and other GitHub supported projects such as Electron, Atom, etc +- Learn best practices for using Git and GitHub - Learn how to use the applications within GitHub's ecosystem to build better software ### Types of contributions we love We're always looking for contributions to help improve these resources. This includes: -- Improving the existing classes and resources -- Translations of existing resources such as the [cheatsheets](/downloads/) into new languages -- Adding new classes or resources aligned with the [goals](#the-goal-of-these-resources) +- Improving the existing cheat sheets +- Translations of existing cheat sheets into new languages +- Adding new courseware or resources aligned with the [goals](#the-goal-of-these-resources) -
+--- ## How to contribute ### Report a bug -Oops, thanks for finding that! If you know how to fix it, please feel free to fork the repository and submit a change via Pull Request (Not sure how to do that? [We have a course for you](https://services.github.com/on-demand/)). +Oops, thanks for finding that! If you know how to fix it, please feel free to fork the repository and submit a change via Pull Request. -If you aren't sure how to fix it or just don't have time, we invite you to open a [new Issue](https://github.com/github/training-kit/issues/new). Please be sure to provide information so we can recreate the error. +If you aren't sure how to fix it or just don't have time, we invite you to open a [new Issue](https://github.com/github/training-kit/issues/new). Please be sure to provide information, so we can recreate the error. ### Translate existing resources -Several community members have been kind enough to translate the [Git Cheat Sheets](https://github.com/github/training-kit/tree/master/downloads) into various languages. At this time, we are only set up to serve the cheat sheets in various languages (but maybe you can help us change that :wink:) If you are planning to contribute a translation, please do the following: +Several community members have been kind enough to translate the Git Cheat Sheets into various languages. At this time, we are only set up to serve the cheat sheets in various languages (but maybe you can help us change that 😉). If you are planning to contribute a translation, please do the following: - Fork this repository -- Create a new folder in the [downloads directory](https://github.com/github/training-kit/tree/master/downloads) using the standard abbreviation for the language you are providing. -- Copy the most recent [English version of the cheatsheet](https://github.com/github/training-kit/blob/master/downloads/github-git-cheat-sheet.md) to the folder you created. +- Create a new folder in the [downloads directory](https://github.com/github/training-kit/tree/main/downloads) using the standard abbreviation for the language you are providing. +- Copy the most recent [English version of the cheat sheet](https://github.com/github/training-kit/blob/main/downloads/github-git-cheat-sheet.md) to the folder you created. - Complete the translation -- Add a link to the translated resource on [/resources/cheatsheets/index.html](https://github.com/github/training-kit/blob/master/resources/cheatsheets/index.html) -- Open a pull request against the `master` branch of this repository. +- Add a link to the translated resource on [/index.html](https://github.com/github/training-kit/blob/main/index.html) +- Open a pull request against the `main` branch of this repository. - Be sure to @ mention a couple of your friends who are native speakers and ask them to review the translation. - Update your translation based on feedback from your friends. @@ -87,63 +63,22 @@ When you are contributing something new, we ask you to be familiar with our cont If you just want to help out, but don't have a particular change in mind, check out the [open issues](https://github.com/github/training-kit/issues) for projects you can tackle, review an [open pull request](https://github.com/github/training-kit/pulls), or check out [the project ROADMAP](https://github.com/github/training-kit/projects/1). -
- -## Step-by-step contribution guide - -### Our content philosophy - -We are eager to create materials that are easy to use and follow! To that end, here are a few guidelines we ask you to keep in mind: - -- We focus on providing friendly and clear, step-by-step instructions. -- Courses should include a project repository that allows each students to complete an activity. -- We focus on minimalism in our instructions, giving the learner the opportunity to study the concept in greater detail with the Tell Me Why feature. -- We appeal to multiple learning styles. Some learners like to read, some like to watch videos, and others just want a recipe. - -### Content structure - -This repository contains two major collections: [on-demand training courses](https://services.github.com/on-demand/) and listings of [our favorite resources](/resources). We help users navigate these collections sequentially with the [learning path](/resources/learning-path). - -#### On-demand course structure - -Adding an on-demand course requires you to do the following: - -- Add a folder in the [paths directory](/paths) based on the course name -- Add the course pages in the new folder you created. For an example of a sequential course, check out the [Introduction to GitHub course](/paths/intro-to-github). For a non-sequential course, check out [Git Out of Trouble](/paths/git-trouble) -- Add the course to the `main` navigation in [_data/navigation.yml](_data/navigation.yml) and add your course navigation in a new section at the end of the files - -### Writing new content - -If you are contributing content, stay consistent with the existing courses by following these guidelines. - -- Vocabulary is italicized to help learners identify their importance and help with cognition. - - Example: A *query* is a request for specific information. -- Button names are bolded to indicate they should be clicked. - - Example: Accept the filler text and click **Commit Changes**. -- Names of repositories, files, branches, variables, or user handles are wrapped in \`backticks\`. - - Example: Initialize the repository with a `README.md` file. -- Code that the learner should type, copy, or execute should be in a fenced code block: - - Example: To see the version of your Git installation, type: - - git --version -- Use given names for complicated concepts, and then explain them. After you've explained them once, use only the given name. - - Example: Any Electron app has 2 types of processes: the *main process*, initialized by `package.json`, and a *renderer process* generated by each web page [...] Running `src/index.js` runs the app's main process. -- Use relevant descriptions of your links, and avoid "click here". - - Example: On GitHub.com, [create a new repository](https://github.com/new). +--- ### Styling content This site uses GitHub's CSS toolkit called [Primer](https://github.com/primer/primer-css). It's easy to use, and if your contribution requires some design or front-end work you should check out the [Primer Docs](http://primercss.io/). +For writing style guides, we lean on the [GitHub Brand Guide](https://brand.github.com/). The [Content](https://brand.github.com/content/) section is a great place to start. + ### Building and testing When you are ready to test your changes, you will want to build the repository locally. This is fully automated through a series of shell scripts based [the scripts to rule them all](https://github.com/github/scripts-to-rule-them-all)! -To build of the materials do the following: +To build the materials do the following: -1. Run `script/setup` -1. Run `sass --watch assets/_scss/main.scss:assets/css/main.css` to compile the SCSS +1. Run `script/bootstrap` to install the dependencies +1. Run `script/build` to build the site 1. Run `script/server` - - When successful, the script will initiate a local server at `http://127.0.0.1:4000/on-demand`. - - The `/on-demand/` directory is a result of the [`baseurl` variable](https://byparker.com/blog/2014/clearing-up-confusion-around-baseurl/) provided by Jekyll. If you'd like to serve your site under a different directory, change it in [`_config.yml`](https://github.com/github/training-kit/blob/contrib-guide/_config.yml). -1. Simply paste that into your favorite web-browser and you will be ready to test + - When successful, the script will initiate a local server at `http://127.0.0.1:4000/`. +1. Simply paste that into your favorite web-browser, and you will be ready to test diff --git a/Gemfile b/Gemfile index b670e7b84..11c3791f3 100644 --- a/Gemfile +++ b/Gemfile @@ -1,6 +1,17 @@ source "https://rubygems.org" -gem 'github-pages' +gem 'jekyll' gem 'html-proofer' -gem 'rack-contrib', '~> 1.1.0' gem 'rake' + +group :jekyll_plugins do + gem 'jekyll-sass-converter', github: 'jekyll/jekyll-sass-converter' + gem 'sass-embedded' + gem 'jekyll-paginate' + gem 'jekyll-sitemap' + gem 'jekyll-gist' + gem 'jekyll-feed' + gem 'jemoji' + gem 'jekyll-redirect-from' + gem 'jekyll-octicons' +end diff --git a/Gemfile.lock b/Gemfile.lock index 7a4af4418..2ef12e484 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,235 +1,157 @@ +GIT + remote: https://github.com/jekyll/jekyll-sass-converter.git + revision: 13d2054514b23ee3f221c4c51eb25bea9bc951f5 + specs: + jekyll-sass-converter (2.2.0) + sass-embedded (~> 1.54) + GEM remote: https://rubygems.org/ specs: - activesupport (4.2.8) - i18n (~> 0.7) - minitest (~> 5.1) - thread_safe (~> 0.3, >= 0.3.4) - tzinfo (~> 1.1) - addressable (2.5.1) - public_suffix (~> 2.0, >= 2.0.2) - coffee-script (2.4.1) - coffee-script-source - execjs - coffee-script-source (1.12.2) + activesupport (7.0.4) + concurrent-ruby (~> 1.0, >= 1.0.2) + i18n (>= 1.6, < 2) + minitest (>= 5.1) + tzinfo (~> 2.0) + addressable (2.8.1) + public_suffix (>= 2.0.2, < 6.0) + async (2.2.1) + console (~> 1.10) + io-event (~> 1.1.0) + timers (~> 4.1) colorator (1.1.0) - colored (1.2) - ethon (0.10.1) - ffi (>= 1.3.0) - execjs (2.7.0) - faraday (0.13.1) - multipart-post (>= 1.2, < 3) - ffi (1.9.18) + concurrent-ruby (1.1.10) + console (1.16.2) + fiber-local + em-websocket (0.5.3) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0) + ethon (0.15.0) + ffi (>= 1.15.0) + eventmachine (1.2.7) + faraday (2.6.0) + faraday-net_http (>= 2.0, < 3.1) + ruby2_keywords (>= 0.0.4) + faraday-net_http (3.0.1) + ffi (1.15.5) + fiber-local (1.0.0) forwardable-extended (2.6.0) - gemoji (3.0.0) - github-pages (155) - activesupport (= 4.2.8) - github-pages-health-check (= 1.3.5) - jekyll (= 3.5.2) - jekyll-avatar (= 0.4.2) - jekyll-coffeescript (= 1.0.1) - jekyll-default-layout (= 0.1.4) - jekyll-feed (= 0.9.2) - jekyll-gist (= 1.4.1) - jekyll-github-metadata (= 2.8.0) - jekyll-mentions (= 1.2.0) - jekyll-optional-front-matter (= 0.2.0) - jekyll-paginate (= 1.1.0) - jekyll-readme-index (= 0.1.0) - jekyll-redirect-from (= 0.12.1) - jekyll-relative-links (= 0.4.1) - jekyll-sass-converter (= 1.5.0) - jekyll-seo-tag (= 2.2.3) - jekyll-sitemap (= 1.0.0) - jekyll-swiss (= 0.4.0) - jekyll-theme-architect (= 0.1.0) - jekyll-theme-cayman (= 0.1.0) - jekyll-theme-dinky (= 0.1.0) - jekyll-theme-hacker (= 0.1.0) - jekyll-theme-leap-day (= 0.1.0) - jekyll-theme-merlot (= 0.1.0) - jekyll-theme-midnight (= 0.1.0) - jekyll-theme-minimal (= 0.1.0) - jekyll-theme-modernist (= 0.1.0) - jekyll-theme-primer (= 0.5.0) - jekyll-theme-slate (= 0.1.0) - jekyll-theme-tactile (= 0.1.0) - jekyll-theme-time-machine (= 0.1.0) - jekyll-titles-from-headings (= 0.4.0) - jemoji (= 0.8.0) - kramdown (= 1.13.2) - liquid (= 4.0.0) - listen (= 3.0.6) - mercenary (~> 0.3) - minima (= 2.1.1) - rouge (= 1.11.1) - terminal-table (~> 1.4) - github-pages-health-check (1.3.5) - addressable (~> 2.3) - net-dns (~> 0.8) - octokit (~> 4.0) - public_suffix (~> 2.0) - typhoeus (~> 0.7) - html-pipeline (2.7.0) + gemoji (3.0.1) + google-protobuf (3.21.9) + html-pipeline (2.14.3) activesupport (>= 2) nokogiri (>= 1.4) - html-proofer (3.7.2) - activesupport (>= 4.2, < 6.0) + html-proofer (5.0.0) addressable (~> 2.3) - colored (~> 1.2) - mercenary (~> 0.3.2) - nokogiri (~> 1.7) - parallel (~> 1.3) - typhoeus (~> 0.7) + async (~> 2.1) + nokogiri (~> 1.13) + rainbow (~> 3.0) + typhoeus (~> 1.3) yell (~> 2.0) - i18n (0.8.6) - jekyll (3.5.2) + zeitwerk (~> 2.5) + http_parser.rb (0.8.0) + i18n (1.12.0) + concurrent-ruby (~> 1.0) + io-event (1.1.2) + jekyll (4.3.1) addressable (~> 2.4) colorator (~> 1.0) - jekyll-sass-converter (~> 1.0) - jekyll-watch (~> 1.1) - kramdown (~> 1.3) + em-websocket (~> 0.5) + i18n (~> 1.0) + jekyll-sass-converter (>= 2.0, < 4.0) + jekyll-watch (~> 2.0) + kramdown (~> 2.3, >= 2.3.1) + kramdown-parser-gfm (~> 1.0) liquid (~> 4.0) - mercenary (~> 0.3.3) + mercenary (>= 0.3.6, < 0.5) pathutil (~> 0.9) - rouge (~> 1.7) + rouge (>= 3.0, < 5.0) safe_yaml (~> 1.0) - jekyll-avatar (0.4.2) - jekyll (~> 3.0) - jekyll-coffeescript (1.0.1) - coffee-script (~> 2.2) - jekyll-default-layout (0.1.4) - jekyll (~> 3.0) - jekyll-feed (0.9.2) - jekyll (~> 3.3) - jekyll-gist (1.4.1) + terminal-table (>= 1.8, < 4.0) + webrick (~> 1.7) + jekyll-feed (0.17.0) + jekyll (>= 3.7, < 5.0) + jekyll-gist (1.5.0) octokit (~> 4.2) - jekyll-github-metadata (2.8.0) - jekyll (~> 3.1) - octokit (~> 4.0, != 4.4.0) - jekyll-mentions (1.2.0) - activesupport (~> 4.0) - html-pipeline (~> 2.3) - jekyll (~> 3.0) - jekyll-optional-front-matter (0.2.0) - jekyll (~> 3.0) + jekyll-octicons (17.7.0) + jekyll (>= 3.6, < 5.0) + octicons (= 17.7.0) jekyll-paginate (1.1.0) - jekyll-readme-index (0.1.0) - jekyll (~> 3.0) - jekyll-redirect-from (0.12.1) - jekyll (~> 3.3) - jekyll-relative-links (0.4.1) - jekyll (~> 3.3) - jekyll-sass-converter (1.5.0) - sass (~> 3.4) - jekyll-seo-tag (2.2.3) - jekyll (~> 3.3) - jekyll-sitemap (1.0.0) - jekyll (~> 3.3) - jekyll-swiss (0.4.0) - jekyll-theme-architect (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-cayman (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-dinky (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-hacker (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-leap-day (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-merlot (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-midnight (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-minimal (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-modernist (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-primer (0.5.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.2) - jekyll-theme-slate (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-tactile (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-time-machine (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-titles-from-headings (0.4.0) - jekyll (~> 3.3) - jekyll-watch (1.5.0) - listen (~> 3.0, < 3.1) - jemoji (0.8.0) - activesupport (~> 4.0) + jekyll-redirect-from (0.16.0) + jekyll (>= 3.3, < 5.0) + jekyll-sitemap (1.4.0) + jekyll (>= 3.7, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + jemoji (0.12.0) gemoji (~> 3.0) html-pipeline (~> 2.2) - jekyll (>= 3.0) - kramdown (1.13.2) - liquid (4.0.0) - listen (3.0.6) - rb-fsevent (>= 0.9.3) - rb-inotify (>= 0.9.7) - mercenary (0.3.6) - mini_portile2 (2.3.0) - minima (2.1.1) - jekyll (~> 3.3) - minitest (5.10.3) - multipart-post (2.0.0) - net-dns (0.8.0) - nokogiri (1.8.2) - mini_portile2 (~> 2.3.0) - octokit (4.7.0) - sawyer (~> 0.8.0, >= 0.5.3) - parallel (1.12.0) - pathutil (0.14.0) + jekyll (>= 3.0, < 5.0) + kramdown (2.4.0) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.3) + listen (3.7.1) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.4.0) + mini_portile2 (2.8.0) + minitest (5.16.3) + nokogiri (1.13.9) + mini_portile2 (~> 2.8.0) + racc (~> 1.4) + octicons (17.7.0) + octokit (4.25.1) + faraday (>= 1, < 3) + sawyer (~> 0.9) + pathutil (0.16.2) forwardable-extended (~> 2.6) - public_suffix (2.0.5) - rack (2.0.3) - rack-contrib (1.1.0) - rack (>= 0.9.1) - rake (12.0.0) - rb-fsevent (0.10.2) - rb-inotify (0.9.10) - ffi (>= 0.5.0, < 2) - rouge (1.11.1) - safe_yaml (1.0.4) - sass (3.5.1) - sass-listen (~> 4.0.0) - sass-listen (4.0.0) - rb-fsevent (~> 0.9, >= 0.9.4) - rb-inotify (~> 0.9, >= 0.9.7) - sawyer (0.8.1) - addressable (>= 2.3.5, < 2.6) - faraday (~> 0.8, < 1.0) - terminal-table (1.8.0) - unicode-display_width (~> 1.1, >= 1.1.1) - thread_safe (0.3.6) - typhoeus (0.8.0) - ethon (>= 0.8.0) - tzinfo (1.2.3) - thread_safe (~> 0.1) - unicode-display_width (1.3.0) - yell (2.0.7) + public_suffix (5.0.0) + racc (1.6.0) + rainbow (3.1.1) + rake (13.0.6) + rb-fsevent (0.11.2) + rb-inotify (0.10.1) + ffi (~> 1.0) + rexml (3.2.5) + rouge (4.0.0) + ruby2_keywords (0.0.5) + safe_yaml (1.0.5) + sass-embedded (1.55.0) + google-protobuf (~> 3.19) + rake (>= 10.0.0) + sawyer (0.9.2) + addressable (>= 2.3.5) + faraday (>= 0.17.3, < 3) + terminal-table (3.0.2) + unicode-display_width (>= 1.1.1, < 3) + timers (4.3.5) + typhoeus (1.4.0) + ethon (>= 0.9.0) + tzinfo (2.0.5) + concurrent-ruby (~> 1.0) + unicode-display_width (2.3.0) + webrick (1.7.0) + yell (2.2.2) + zeitwerk (2.6.1) PLATFORMS ruby DEPENDENCIES - github-pages html-proofer - rack-contrib (~> 1.1.0) + jekyll + jekyll-feed + jekyll-gist + jekyll-octicons + jekyll-paginate + jekyll-redirect-from + jekyll-sass-converter! + jekyll-sitemap + jemoji rake + sass-embedded BUNDLED WITH - 1.15.4 + 2.3.19 diff --git a/README.md b/README.md index 1a9e37c43..6142d1c11 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,39 @@ -![servicesbanner](https://cloud.githubusercontent.com/assets/13326548/21035994/ad40c19c-bd77-11e6-97fa-78b068050c05.jpg) +# GitHub Training Kit -[![Build Status](https://travis-ci.org/github/training-kit.svg?branch=master)](https://travis-ci.org/github/training-kit) +Open source courseware from the GitHub Professional Services team. -# GitHub Training Kit -### Home of GitHub's On-Demand training +## We ❤️ contributors like you -This repository contains the completely open source on-demand training hosted at https://services.github.com/on-demand/. These materials are provided under a [_Creative Commons License_ license](https://github.com/github/training-kit/blob/master/LICENSE). +**We’re eager to work with you**, our user community, to improve these materials and develop new ones. Please check out our [CONTRIBUTING guide](CONTRIBUTING.md) for more information on getting started. -## We :heart: Contributors Like You! +## Looking for a resource that was once housed in training-kit? -**We’re eager to work with you**, our user community to improve these materials and develop new ones. Please check out our [CONTRIBUTING guide](https://github.com/github/training-kit/blob/master/CONTRIBUTING.md) for more information on getting started. +This repository currently contains Git and GitHub cheat sheets. If you're looking for a project that used to be housed here, such as On-Demand training, reading lists, videos, and book recommendations, see [this commit](https://github.com/github/training-kit/tree/4fbf180e980ef973ba4cc4b8ef3d5f278ddc8c08) in the repository's history. -## Projects Used in Training-Kit +## Projects used in training-kit - We use [Jekyll](https://jekyllrb.com/) and [Markdown](https://guides.github.com/features/mastering-markdown/). - Our content is styled using the [Primer CSS toolkit](https://github.com/primer/primer-css). -- The corner badge of an Octocat is from [tholman.com](http://tholman.com/github-corners/) -## Packaging for Viewing Behind Your Firewall +## Packaging for viewing behind your firewall -If you'd like to have a copy of the files to be served from a web server inside of your firewall, start by running `script/package`. +If you'd like to have a copy of the files to be served from a web server inside your firewall, start by running `script/package`. 1. Run `script/package` to create a release tarball. This will be in the format `release-XXXXXXX.tgz` for you to take wherever you want. 2. To test this looks okay, create some folders `mkdir -p test_site/kit`. -3. Untar the release, `tar -xzf release-XXXXXXX.tgz -C test_site/kit`. +3. Extract the release, `tar -xzf release-XXXXXXX.tgz -C test_site/kit`. 4. Switch into the test_site directory, `cd test_site`. -5. View the site with `python -m SimpleHTTPServer`. _Note: Some servers are obviously more advanced than others and can handle redirects, smart recognition of `.html` files, etc_ - -## Licenses +5. View the site: + - For python version 2.x, run: `python -m SimpleHTTPServer` + - For python version 3.x, run: `python -m http.server` + - _Note: Some servers are more advanced than others and can handle redirects, smart recognition of `.html` files, etc_ -Site content is licensed under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/). CC-BY-4.0 gives you permission to use content for almost any purpose but does not grant you any trademark permissions, so long as you note the license and give credit, such as follows: +Site content is licensed under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/). CC-BY-4.0 gives you permission to use the content for almost any purpose but does not grant you any trademark permissions, so long as you note the license and give credit, such as follows: -> Content based on -> services.github.com/on-demand/ -> used under the -> CC-BY-4.0 -> license. +> Content based on [github.github.com/training-kit/](https://github.github.com/training-kit) used under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/) license. Code used to build and test the site as well as code samples on the site, if any, are licensed under [CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/legalcode). CC0 waives all copyright restrictions but does not grant you any trademark permissions. -This means you can use the content and code in this repository except for GitHub trademarks in your own projects. +This means you can use the content and code in this repository except for GitHub trademarks in your projects. When you contribute to this repository you are doing so under the above licenses. diff --git a/Rakefile b/Rakefile index a2e66a52a..1fe5893dd 100644 --- a/Rakefile +++ b/Rakefile @@ -1,11 +1,38 @@ -desc 'Clean up generated site' +require 'html-proofer' +require 'jekyll' + +Rake.application.options.trace = true + +desc 'Remove all generated files: destination folder, metadata file, Sass and Jekyll caches.' task :clean do - sh 'rm -rf _site' + Jekyll::Commands::Clean.process({}) end -task :test do - sh 'bundle exec jekyll build' +desc 'Build and serve the site' +task serve: [:build] do + Jekyll::Commands::Serve.process({}) +end + +desc 'Build the site' +task build: [:clean] do + Jekyll::Commands::Build.process({}) +end +desc 'Build and test the site' +task test: [:build] do + options = { + :check_html => true, # Validate HTML + :empty_alt_ignore => false, # Allow images with empty alt tags + :check_favicon => true, # Check whether favicons are valid + :check_img_http => true, # Enforce that images use HTTPS + typhoeus: { + headers: { + # This is required to validate links to docs.github.com + "Accept-Encoding" => "gzip", + } + } + } + HTMLProofer.check_directory("./_site", options).run end -task default: :test \ No newline at end of file +task default: :test diff --git a/_config.yml b/_config.yml index f655900b4..1a124d15e 100644 --- a/_config.yml +++ b/_config.yml @@ -3,38 +3,25 @@ domain: services.github.com author: GitHub, Inc. email: services@github.com - # Site Settings -locale : "en-US" +locale: "en-US" # Keep original, do not replace -title : "On Demand Training" -title_separator : "-" -name : "GitHub, Inc." -description : "You're in control. We're with you along the way." -baseurl : "/on-demand" # the subpath of your site, e.g. "/blog" -gh_repo : -teaser : # filename of teaser fallback teaser image placed in /images/, .e.g. "500x300.png" -breadcrumbs : true # true, false (default) -words_per_minute : 200 -comments: - provider : # false (default), "disqus", "discourse", "facebook", "google-plus", custom" - disqus: - shortname : # https://help.disqus.com/customer/portal/articles/466208-what-s-a-shortname- - discourse: - server : # https://meta.discourse.org/t/embedding-discourse-comments-via-javascript/31963 , e.g.: meta.discourse.org - facebook: - # https://developers.facebook.com/docs/plugins/comments - appid : - num_posts : # 5 (default) - colorscheme : # "light" (default), "dark" - - - +title: "GitHub Cheatsheets" +title_separator: "-" +name: "GitHub, Inc." +description: +url: "https://training.github.com" +baseurl: "" # the subpath of your site, e.g. "/blog" +gh_repo: github/training-kit +repository: github/training-kit +teaser: # filename of teaser fallback teaser image placed in /images/, .e.g. "500x300.png" +breadcrumbs: true # true, false (default) +words_per_minute: 200 analytics: - provider : google # false (default), "google", "google-universal", "custom" + provider: google # false (default), "google", "google-universal", "custom" google: - tracking_id : UA-3769691-2 + tracking_id: UA-3769691-2 markdown_ext: "markdown,mkdown,mkdn,mkd,md" @@ -45,8 +32,7 @@ lsi: false excerpt_separator: "\n\n" incremental: false -# standard jekyll configuration - +# Standard jekyll configuration parentsite: https://services.github.com permalink: /articles/:title/ plugins: @@ -55,18 +41,22 @@ plugins: - jekyll-gist - jekyll-feed - jemoji + - jekyll-redirect-from + - jekyll-octicons exclude: -- bin -- config.rb -- Gemfile -- Gemfile.lock -- gems -- Procfile -- Rakefile -- README.md -- script -- vendor + - bin + - config.rb + - Gemfile* + - gems + - node_modules + - Procfile + - Rakefile + - README.md + - script + - vendor + - package.json + - package-lock.json collections: modules: @@ -75,20 +65,25 @@ collections: output: true include: -- _stylesheets -- _javascript + - _stylesheets + - _javascript + +# Primer CSS (https://primer.style/css/getting-started#for-a-jekyll-site) sass: + sass_dir: assets/css load_paths: - assets/_scss - node_modules - style: :compressed + style: compressed + implementation: sass-embedded # Custom site configuration lang: en defaults: - - - scope: + - scope: path: "" values: lang: "en" + redirect_to: + - https://training.github.com diff --git a/_data/navigation.yml b/_data/navigation.yml deleted file mode 100644 index 3306f573f..000000000 --- a/_data/navigation.yml +++ /dev/null @@ -1,341 +0,0 @@ -banner: - en: - title: On Demand Training - url: / - es: - title: Aprende a tu ritmo - url: /es/ - -main: - en: - - title: Resources - url: /resources/ - - title: Learning Path - url: /resources/learning-path/ - - title: Upcoming Events - abs: https://services.github.com/#upcoming-events - - title: Customized Training - abs: https://services.github.com/customized-training - - es: - - title: Resources - url: /resources/ - - title: Itinerario de aprendizaje - url: /resources/learning-path/es/ - - title: Upcoming Events - abs: https://services.github.com/#upcoming-events - - title: Customized Training - abs: https://services.github.com/customized-training - -# When creating new sidebar navs, remember the url in this document needs to match the url assigned in the permalink field. - -intro-nav: - - title: "Introduction to GitHub" - url: /intro-to-github/ - - title: "Create a GitHub Account" - url: /intro-to-github/create-github-account - - title: "Join the Class Repository" - url: /intro-to-github/join-class-repository - - title: "Explore the GitHub Repository" - url: /intro-to-github/explore-github-repository - - title: "Use GitHub Flow" - url: /intro-to-github/use-github-flow - - title: "Create a Branch" - url: /intro-to-github/create-a-branch - - title: "Find Your Coordinates" - url: /intro-to-github/find-your-coordinates - - title: "Work on GitHub" - url: /intro-to-github/work-on-github - - title: "Create a Pull Request" - url: /intro-to-github/create-pull-request - - title: "Collaborate on GitHub" - url: /intro-to-github/collaborate-on-github - - title: "Edit Files on GitHub" - url: /intro-to-github/edit-files-on-github - - title: "Merge Your Pull Request" - url: /intro-to-github/merge-pull-request - - title: "You Completed the GitHub Flow" - url: /intro-to-github/you-completed-github-flow - - -intro-nav-es: - - title: "Introducción a GitHub" - url: /intro-to-github/es/ - - title: "Crear cuenta GitHub" - url: /intro-to-github/es/crear-cuenta-github - - title: "Únete al repositorio de la clase" - url: /intro-to-github/es/unete-repo-clase - - title: "Explora el repositorio GitHub" - url: /intro-to-github/es/explora-repositorio - - title: "Utiliza el flujo de trabajo GitHub" - url: /intro-to-github/es/flujo-github - - title: "Creando una rama o branch" - url: /intro-to-github/es/creando-rama-branch - - title: "Busca tus coordenadas" - url: /intro-to-github/es/buscar-coordenadas - - title: "Trabajar en GitHub" - url: /intro-to-github/es/trabajar-en-github - - title: "Crear un Pull Request" - url: /intro-to-github/es/crear-pull-request - - title: "Colaborar en GitHub" - url: /intro-to-github/es/colaborar-en-github - - title: "Editar archivos en GitHub" - url: /intro-to-github/es/editar-en-github - - title: "Hacer Merge de tu Pull Request" - url: /intro-to-github/es/merge-pull-requests - - title: "Has completado el Flujo GitHub" - url: /intro-to-github/es/celebrar - -github-desktop-nav: - - title: "GitHub Pages & GitHub Desktop" - url: /github-desktop/ - - title: "Install GitHub Desktop" - url: /github-desktop/install-github-desktop - - title: "Create the Remote Repository on GitHub" - url: /github-desktop/create-remote-repository - - title: "Choose a GitHub Pages Theme" - url: /github-desktop/choose-github-pages-theme - - title: "Clone the Repository with GitHub Desktop" - url: /github-desktop/clone-repository-github-desktop - - title: "Create Local Branches With GitHub Desktop" - url: /github-desktop/create-branches-github-desktop - - title: "Make Local Changes With GitHub Desktop" - url: /github-desktop/make-changes-github-desktop - - title: "Add Local Commits With GitHub Desktop" - url: /github-desktop/add-commits-github-desktop - - title: "Open a Pull Request With GitHub Desktop" - url: /github-desktop/pull-request-github-desktop - - title: "Merge Your Pull Request on GitHub" - url: /github-desktop/merge-pull-request-github - - title: "View Your GitHub Pages Site" - url: /github-desktop/view-github-pages-site - - title: "Push to GitHub with GitHub Desktop" - url: /github-desktop/push-with-github-desktop - - title: "Add Your GitHub Pages Site to the Showcase" - url: /github-desktop/add-github-pages-site-showcase - - title: "Review the Local GitHub Flow" - url: /github-desktop/review-github-flow - - title: "Push to GitHub & Create a Pull Request" - url: /github-desktop/push-pull-request-github-desktop - - title: "Collaborate With GitHub Pull Requests" - url: /github-desktop/collaborate-github-pull-requests - - title: "Merge Your Pull Request on GitHub" - url: /github-desktop/merge-pull-request-showcase - -github-desktop-nav-es: - - title: "GitHub Pages y GitHub Desktop" - url: /github-desktop/es/ - - title: "Instalar GitHub Desktop" - url: /github-desktop/es/instalar-github-desktop - - title: "Crear el repositorio remoto en GitHub" - url: /github-desktop/es/crear-repo-remoto - - title: "Elegir un tema de GitHub Pages" - url: /github-desktop/es/elegir-tema-github-pages - - title: "Clonar el repositorio con GitHub Desktop" - url: /github-desktop/es/clonar-repositorio-github-desktop - - title: "Crear branches en local con GitHub Desktop" - url: /github-desktop/es/crear-branches-github-desktop - - title: "Hacer cambios en local con GitHub Desktop" - url: /github-desktop/es/hacer-cambios-github-desktop - - title: "Añadir commits locales con GitHub Desktop" - url: /github-desktop/es/nuevos-commits-github-desktop - - title: "Abrir un Pull Request con GitHub Desktop" - url: /github-desktop/es/pull-request-github-desktop - - title: "Hacer merge de tu Pull Request en GitHub" - url: /github-desktop/es/merge-pull-request-github - - title: "Ver tu sitio hecho con GitHub Pages" - url: /github-desktop/es/ver-sitio-github-pages - - title: "Hacer Push a GitHub con GitHub Desktop" - url: /github-desktop/es/push-con-github-desktop - - title: "Añadir tu sitio hecho con GitHub Pages al Escaparate" - url: /github-desktop/es/añadir-github-pages-escaparate - - title: "Revisar el Flujo GitHub local" - url: /github-desktop/es/revisar-github-flow - - title: "Push a GitHub y crear un Pull Request" - url: /github-desktop/es/push-pull-request-github-desktop - - title: "Colaborar con Pull Requests en GitHub" - url: /github-desktop/es/colaborar-github-pull-requests - - title: "Hacer merge de tu Pull Request en GitHub" - url: /github-desktop/es/merge-pull-request-showcase - -github-cli: - - title: "GitHub Pages & Git in the Command Line" - url: /github-cli/ - - title: "Git Configuration" - url: /github-cli/git-configuration - - title: "Create the Remote Repository on GitHub" - url: /github-cli/create-remote-repository - - title: "Choose a GitHub Pages Theme" - url: /github-cli/choose-github-pages-theme - - title: "Clone the Repository Using the Command Line" - url: /github-cli/clone-repo-cli - - title: "Create Local Branches With Git" - url: /github-cli/create-branches-git - - title: "Make Local Changes With Git" - url: /github-cli/make-local-changes-git - - title: "Add Local Commits With Git" - url: /github-cli/add-commits-git - - title: "Open a Pull Request on GitHub" - url: /github-cli/open-pull-request-github - - title: "Merge Your Pull Request on GitHub" - url: /github-cli/merge-pull-request-github - - title: "View Your GitHub Pages Site" - url: /github-cli/view-github-pages-site - - title: "Git Push & Git Pull" - url: /github-cli/git-push-git-pull - - title: "Add Your GitHub Pages Site to the Showcase" - url: /github-cli/add-github-pages-site-showcase - - title: "Review the Local GitHub Flow in the Command Line" - url: /github-cli/github-flow-cli - - title: "Review Pushing and Opening Pull Requests" - url: /github-cli/git-push-open-pull-request - - title: "Collaborate With GitHub Pull Requests" - url: /github-cli/collaborate-github-pull-requests - - title: "Merge Your Pull Request on GitHub" - url: /github-cli/merge-pull-request-github-showcase - -advanced: - - title: "Welcome to Git Out Of Trouble" - url: /git-trouble/ - - title: "Set Up Your Git Scenario Environment" - url: /git-trouble/git-set-up - - title: "Git Trouble Scenarios" - url: /git-trouble/git-scenarios - children: - - title: "Too Many (small) Git Commits" - url: /git-trouble/too-many-commits - - title: "Git Commit Message Sucks" - url: /git-trouble/git-commit-message - - title: "Git Committed to Wrong Branch" - url: /git-trouble/git-commit-wrong-branch - - title: "Accidental Git Commit" - url: /git-trouble/accidental-git-commit - - title: "Just Make it Go Away - Breaking Things With Git" - url: /git-trouble/breaking-things-with-git - -windows: - - title: "Welcome to GitHub for Windows Users" - url: /windows/ - - title: "Get Started" - url: /windows/getting-started - children: - - title: "Install Git" - url: /windows/installing-git - - title: "Configure Git" - url: /windows/configure-git - - title: "Configure Line Endings" - url: /windows/git-crlf - - title: "Store Your Password" - url: /windows/git-credentials - - title: "Editors" - url: /windows/editors - children: - - title: "vi Basics" - url: /windows/vi-basics - - title: "Configure Other Editors" - url: /windows/configure-editors - - title: "Visual Studio Integration" - url: /windows/visual-studio - children: - - title: "Install the GitHub Extension" - url: /windows/install-visual-studio - - title: "Start a Project" - url: /windows/vs-start-project - - title: "Make a Commit" - url: /windows/vs-make-commit - - title: "Sharing and Receiving Changes" - url: /windows/vs-push-changes - - title: "What is Sync?" - url: /windows/vs-sync - - title: "Congratulations" - url: /windows/congrats - - -github-graphql: - - title: "Introduction to GraphQL" - url: /graphql/ - - title: "Use GraphQL for the First Time" - url: /graphql/first-use - - title: "Build a Query" - url: /graphql/first-query - - title: "Grab a Query's Response" - url: /graphql/query-info - - title: "Use a Query to Find Specific Information" - url: /graphql/another-query - - title: "Create a Mutation" - url: /graphql/mutation - - -create-an-app-in-electron: - - title: "Get Started with Electron" - url: /electron/create-an-app/ - - title: "Create your app" - url: /electron/create-an-app/create-your-app/ - - title: "Push your project to GitHub" - url: /electron/create-an-app/push-your-project-to-github/ - - title: "Create your App's Files" - url: /electron/create-an-app/create-your-apps-files/ - - title: "Run Your First Electron App" - url: /electron/create-an-app/run-your-first-electron-app/ - - title: "Add your index.html" - url: /electron/create-an-app/add-your-index-html/ - - title: "Add CSS" - url: /electron/create-an-app/add-css/ - - title: "Add JavaScript" - url: /electron/create-an-app/add-javascript/ - - title: "Celebrate" - url: /electron/create-an-app/celebrate/ - - -electron-package-your-app: - - title: "Package Your App for Downloads" - url: /electron/package-your-app/ - - title: "Use electron-packager" - url: /electron/package-your-app/use-electron-packager/ - - title: "Add an icon" - url: /electron/package-your-app/add-an-icon/ - - title: "Test Your App" - url: /electron/package-your-app/test-your-app/ - - title: "Celebrate" - url: /electron/package-your-app/celebrate/ - - - -electron-share-your-app: - - title: "Share Your App" - url: /electron/share-your-app/ - - title: "List on App Stores" - url: /electron/share-your-app/list-on-app-stores/ - - title: "Share on Websites" - url: /electron/share-your-app/share-on-websites/ - - title: "Celebrate" - url: /electron/share-your-app/celebrate/ - -merge-conflicts: - - title: "Managing Merge Conflicts" - url: /merge-conflicts/ - - title: "Set Up the Repository" - url: /merge-conflicts/setup/ - - title: "A Normal Merge" - url: /merge-conflicts/normal-merge/ - - title: "Merge Conflict Description" - url: /merge-conflicts/mc-description/ - - title: "Your First Conflict" - url: /merge-conflicts/first-conflict/ - - title: "Skatetocat's Simple Conflict" - url: /merge-conflicts/example-01/ - - title: "Shoptocat and Supportcat Help" - url: /merge-conflicts/example-02/ - - title: "Momtocat and Poptocat Lend a Hand" - url: /merge-conflicts/example-03/ - - title: "What Next?" - url: /merge-conflicts/what-next/ - - title: "Using GUIs to Handle Merge Conflicts" - url: /merge-conflicts/ide-intro/ - children: - - title: "Atom" - url: /merge-conflicts/ide-atom/ - - title: "Visual Studio Code" - url: /merge-conflicts/ide-vs-code/ - - title: "GitHub Extension for Visual Studio" - url: /merge-conflicts/ide-vs-ext/ diff --git a/_data/ui-text.yml b/_data/ui-text.yml deleted file mode 100644 index 6958a46ce..000000000 --- a/_data/ui-text.yml +++ /dev/null @@ -1,88 +0,0 @@ -# User interface text and labels - -# English (default) -# ----------------- -en: &DEFAULT_EN - name : "English" - page : "Page" - pagination_previous : "Previous" - pagination_next : "Next" - breadcrumb_home_label : "Home" - breadcrumb_separator : "/" - toc_label : "On This Page" - ext_link_label : "Direct Link" - less_than : "less than" - minute_read : "minute read" - minutes_read : "minutes read" - share_on_label : "Share on" - meta_label : - tags_label : "Tags:" - categories_label : "Categories:" - date_label : "Updated:" - comments_label : "Leave a Comment" - more_label : "Learn More" - related_label : "You May Also Enjoy" - follow_label : "Follow:" - feed_label : "Feed" - powered_by : "Powered by" - website_label : "Website" - email_label : "Email" - recent_posts : "Recent Posts" - didnt-push : "I didn't push" - pushed : "I pushed" - refresh : "I need a refresher" - show-me-how : "Show me how" - troubleshooting : "Help me troubleshoot" - tell-me-why : "Tell me why" - get-help : "Get Help" - stuck : "Stuck? Open an issue in the repository for this class and mention @githubteacher for help from one of the GitHub trainers!" - continue : "Continue" -en-US: - <<: *DEFAULT_EN -en-UK: - <<: *DEFAULT_EN - -# Spanish -# -------------- -es: &DEFAULT_ES - name : "Español" - page : "Página" - pagination_previous : "Anterior" - pagination_next : "Siguiente" - breadcrumb_home_label : "Inicio" - breadcrumb_separator : "/" - toc_label : "Contenidos" - ext_link_label : "Enlace" - less_than : "menos de" - minute_read : "minuto de lectura" - minutes_read : "minutos de lectura" - share_on_label : "Compartir" - meta_label : - tags_label : "Etiquetas:" - categories_label : "Categorías:" - date_label : "Actualizado:" - comments_label : "Comentar" - more_label : "Ver más" - related_label : "Podrías ver también" - follow_label : "Seguir:" - feed_label : "Feed" - powered_by : "Powered by" - website_label : "Sitio web" - email_label : "Email" - recent_posts : "Entradas recientes" - didnt-push : "No hice push" - pushed : "Hice push" - refresh : "Necesito un recordatorio" - show-me-how : "Enséñame cómo" - troubleshooting : "Ayúdame a resolver" - tell-me-why : "Dime por qué" - get-help : "Pide Ayuda" - stuck : "¿Atascado? Abre un tema (issue) en el repositorio para esta clase y menciona a @githubteacher para obtener ayuda de uno de los instructores de GitHub." - continue : "Continuar" -es-ES: - <<: *DEFAULT_ES -es-CO: - <<: *DEFAULT_ES - -# Another locale -# -------------- diff --git a/_includes/activity/gh-pages/02-create-profile.md b/_includes/activity/gh-pages/02-create-profile.md deleted file mode 100644 index 54fcffb94..000000000 --- a/_includes/activity/gh-pages/02-create-profile.md +++ /dev/null @@ -1,34 +0,0 @@ -{% capture activity-text %} -# Activity: Create a Profile Page - -Follow the steps below to update your public profile page! - -Don't worry if you don't want to put your actual information up online. It's OK to just make stuff up. But if you do want to create an actual portfolio, we'd recommend doing that here! - -1. On your personal repo, create a new branch named `profile-info` -2. Edit the `content.md` file located in the `/_index/` folder. - - Add a new image - - Add your name - - Add a title - - Add bio information -3. Commit the changes you made to the `content.md` file. -4. Edit the `_config.yml` file by changing the following: - - title - - email - - twitter - - github - - description fields -5. Change the `baseurl:` to the **name of your GitHub repo**. -6. Change the `url:` to `http://username.github.io`, where `username` is your GitHub username. -7. Create a Pull Request comparing the `profile-info` branch to the base branch `gh-pages`. -8. Merge the Pull Request. -9. Look at your creation at `http://username.github.io/repo-name`. - -{% endcapture %} - -
- {{ activity-text | markdownify }} -
- -Need help? **Open an issue** [in our class repository](https://github.com/githubschool/on-demand-github-pages/issues/new) for answers from GitHub trainers! -{: .notice--success} diff --git a/_includes/activity/gh-pages/03-create-new-page.md b/_includes/activity/gh-pages/03-create-new-page.md deleted file mode 100644 index 604a79982..000000000 --- a/_includes/activity/gh-pages/03-create-new-page.md +++ /dev/null @@ -1,19 +0,0 @@ -{% capture activity-text %} -# Activity: Create a New Page - -Time to add our work history as a page to our Jekyll site. - -1. Create a new branch off the ```gh-pages``` branch named ```work-history```. -2. In the ```_pages``` folder, create a **new** file named ```work-history.md```. -3. Add your work history to the file and click ```Commit```. If you'd like, you can copy and paste the work history we provided earlier in the course. -4. Create a **pull request** selecting ```gh-pages``` as the **base** and ```work-history``` as the **compare**. -5. Merge the **pull request**. -6. Navigate to your website to see the changes you just made. -{% endcapture %} - -
- {{ activity-text | markdownify }} -
- -Need help? **Open an issue** [in our class repository](https://github.com/githubschool/on-demand-github-pages/issues/new) for answers from GitHub trainers! -{: .notice--success} diff --git a/_includes/activity/gh-pages/04-more-content.md b/_includes/activity/gh-pages/04-more-content.md deleted file mode 100644 index 2ccf4be04..000000000 --- a/_includes/activity/gh-pages/04-more-content.md +++ /dev/null @@ -1,28 +0,0 @@ -{% capture activity-text %} -# Activity: Additional Challenges - -Below are some projects that you can take on that will challenge your templating skills. We're leaving them more open-ended instead of giving you step-by-step instructions, so feel free to ask a mentor if you need help. - -### Add Nav Links - -"Edit your project so that you can have pages which have a `title:` element but which don't show up in the nav bar. You'll need to come up with a system (a mentor can help) and edit the `_includes/header.html` page, as well as the front matter in all of your site pages." - -### Work History with Style - -Earlier you created a Work History page. This isn't very well formatted though. Try using CSS and templates to clean up the page. If you create a Work History template you can wrap the content in a new div, and then format the elements using CSS so that formatting only applies to that page. - -### Collections - -You might also look into the "collections" functionality in Jekyll. This would let you create a different markdown file (and front matter data) for each job description. How might this make formatting the page easier? - - - - -{% endcapture %} - -
- {{ activity-text | markdownify }} -
- -Need help? **Open an issue** [in our class repository](https://github.com/githubschool/on-demand-github-pages/issues/new) for answers from GitHub trainers! -{: .notice--success} diff --git a/_includes/activity/github-CLI/clisurvey.md b/_includes/activity/github-CLI/clisurvey.md deleted file mode 100644 index 152a301d7..000000000 --- a/_includes/activity/github-CLI/clisurvey.md +++ /dev/null @@ -1,2 +0,0 @@ -## We Love Feedback :heart: - Please take _literally less than a minute_ to let us know what you think of this course. You may also choose to opt-in for updates on future classes. [Start Survey](http://www.surveygizmo.com/s3/3288550/cli)! diff --git a/_includes/activity/github-CLI/git-diff.md b/_includes/activity/github-CLI/git-diff.md deleted file mode 100644 index d3aa6b3fc..000000000 --- a/_includes/activity/github-CLI/git-diff.md +++ /dev/null @@ -1,7 +0,0 @@ -# Git Diff - -1. Type `git diff`. Let's start with `git diff` without any options. This command compares the changes you have made in the working directory with the staged version of the file. -1. Type `git diff --staged`. When you add the `--staged` option, `git diff` will compare the staged version with the most recent committed version of the file. -1. Type `git diff HEAD`. When you add `HEAD` after the `git diff` command, git combines the changes in your working and staging areas and compares them with the version of the file that is currently designated as the `HEAD`. In most cases, this is the most recent commit in the history of the file. -1. Type `git diff --color-words`. The default for `git diff` is to compare lines of change, but sometimes this is not helpful when we have only made a small change. We can add the option `--color-words` to get a word-by-word comparison instead of the line level comparison. -1. When you are finished, `commit` your file changes. diff --git a/_includes/activity/github-CLI/git-log.md b/_includes/activity/github-CLI/git-log.md deleted file mode 100644 index cecddc1db..000000000 --- a/_includes/activity/github-CLI/git-log.md +++ /dev/null @@ -1,11 +0,0 @@ -To see the history of commits, use the command `git log`. It provides a list of all of the commits made on our branch with the most recent commit first. You aren't stuck with the default behavior - try these log commands to view history in different ways. - -1. Type `git log`. -1. Press `q`. You can press the up or down arrows or press enter to view additional log entries. Type q to quit viewing the log and return to the command prompt. -1. Type `git log -5` to only see the last 5 commits. -1. Type `git log --oneline`. -1. Type `git log --oneline --graph`. -1. Type `git log --oneline --graph --decorate`. -1. Type `git log --oneline --graph --decorate --all`. -1. Type `git log --stat`. -1. Type `git log --patch`. diff --git a/_includes/activity/github-desktop-es/01-crear-repositorio.md b/_includes/activity/github-desktop-es/01-crear-repositorio.md deleted file mode 100644 index f80cbe96b..000000000 --- a/_includes/activity/github-desktop-es/01-crear-repositorio.md +++ /dev/null @@ -1,18 +0,0 @@ -[//]: # "This is used in both the CLI and Desktop course" - -Ahora que tienes instalado localmente todo lo que necesitas para trabajar con Git y GitHub, vamos a crear el repositorio que alojará tu nuevo sitio web. - -![gif of following the directions below]({{ site.baseurl }}/images/gifs/github-desktop/create-repo.gif) - -1. En GitHub.com, [crea un nuevo repositorio](https://github.com/new). -1. Nombra tu repositorio `TU-USUARIO.GITHUB.IO` - - > El nombre de tu repositorio será parte del enlace a tu sitio web. Si utilizas la convención para el nombre descrita, tu sitio web se servirá en esa URL. - -1. Introduce una descripción para tu repositorio. -1. Escoge visibilidad **Public**. - - > Recomendamos que crees un repositorio público. Los repositorios públicos son gratis. Incluso si seleccionas un repositorio privado, tu sitio web publicado será público. - -1. Selecciona **Initialize this repository with a README**. -1. Haz clic en **Create repository**. diff --git a/_includes/activity/github-desktop-es/07-merge-pull-request.md b/_includes/activity/github-desktop-es/07-merge-pull-request.md deleted file mode 100644 index 3a52f7cfd..000000000 --- a/_includes/activity/github-desktop-es/07-merge-pull-request.md +++ /dev/null @@ -1,8 +0,0 @@ -[//]: # "This is used in both the CLI and Desktop course" - -Dado que este repositorio es tuyo, probablemente no tienes a nadie con quien colaborar (todavía). Adelante, haz merge de tu Pull Request ahora. - -![gif of following the directions below]({{ site.baseurl }}/images/gifs/github-desktop/merge-pr.gif) - -1. En GitHub.com, navega hasta el Pull Request que acabas de abrir. -2. Haz scroll hasta abajo y haz clic en el gran botón verde que dice **Merge Pull Request**. diff --git a/_includes/activity/github-desktop-es/12-anadir-repo-clase.md b/_includes/activity/github-desktop-es/12-anadir-repo-clase.md deleted file mode 100644 index 675c98092..000000000 --- a/_includes/activity/github-desktop-es/12-anadir-repo-clase.md +++ /dev/null @@ -1,5 +0,0 @@ -[//]: # "This is used in both the CLI and Desktop course" - -1. Visita el [repositorio de la clase](https://github.com/githubschool/on-demand-github-pages/). -1. Haz clic en la pestaña **Issues**. -1. Solicita acceso para push mediante la [creación de un Issue](https://github.com/githubschool/on-demand-github-pages/issues/). diff --git a/_includes/activity/github-desktop-es/15-colaborar-prs.md b/_includes/activity/github-desktop-es/15-colaborar-prs.md deleted file mode 100644 index 50a010ae2..000000000 --- a/_includes/activity/github-desktop-es/15-colaborar-prs.md +++ /dev/null @@ -1,7 +0,0 @@ -[//]: # "This is used in both the CLI and Desktop course" - -Ahora es momento de que colabores con otros estudiantes que están siguiendo esta clase alrededor de todo el mundo :earth_americas:. - -1. En el [repositorio de la clase en GitHub.com](https://github.com/githubschool/on-demand-github-pages/), navega a la [pestaña Pull Requests](https://github.com/githubschool/on-demand-github-pages/pulls). -2. Echa un vistazo a los otros pull requests. ¿Parecen buenos cambios, con los tests de CI aprobados? ¡Siéntete libre de enviar un mensaje de ánimo! -3. En tu pull request, espera a ver si el branch pasa los tests de Travis CI y está listo para hacer merge. diff --git a/_includes/activity/github-desktop-es/16-merge-pr.md b/_includes/activity/github-desktop-es/16-merge-pr.md deleted file mode 100644 index caf116bc8..000000000 --- a/_includes/activity/github-desktop-es/16-merge-pr.md +++ /dev/null @@ -1,19 +0,0 @@ -[//]: # "This is used in both the CLI and Desktop course" - -Ahora que tus tests han pasado, hagamos clic en el gran botón verde para añadir tu sitio a nuestro directorio. - -![gif of following the directions below]({{ site.baseurl }}/images/gifs/github-desktop/merge.gif) - -1. En GitHub.com, comprueba que los tests están pasando. -2. Haz clic en **Merge**. -3. Haz clic en **Confirm Merge**. -4. Elimina el branch. - - -## :tada: ¡Enhorabuena! - -Una vez que hayas hecho merge de tu pull request, ¡has completado el flujo de trabajo GitHub! Actualiza esta página para ver tu incorporación a nuestro gráfico de contribuciones. - -
-
-
diff --git a/_includes/activity/github-desktop-es/desktopsurvey.md b/_includes/activity/github-desktop-es/desktopsurvey.md deleted file mode 100644 index 2c3395535..000000000 --- a/_includes/activity/github-desktop-es/desktopsurvey.md +++ /dev/null @@ -1,2 +0,0 @@ -## Nos encanta el feedback :heart: - Por favor tómate _literalmente menos de un minuto_ para hacernos saber qué te ha parecido este curso. También puedes optar por apuntarte para recibir actualizaciones sobre clases futuras. [Empezar encuesta](http://www.surveygizmo.com/s3/3288550/desktop)! diff --git a/_includes/activity/github-desktop-es/elegir-tema.md b/_includes/activity/github-desktop-es/elegir-tema.md deleted file mode 100644 index 7fbc78b21..000000000 --- a/_includes/activity/github-desktop-es/elegir-tema.md +++ /dev/null @@ -1,15 +0,0 @@ -[//]: # "This is used in both the CLI and Desktop course" - -Este curso utilizará GitHub Pages para crear tu sitio web. Para inicializar GitHub Pages necesitamos seguir algunos pasos más: - -![gif of following the directions below]({{ site.baseurl }}/images/gifs/github-desktop/choose-a-theme.gif) - -1. En tu recientemente creado repositorio, haz clic en la pestaña **Settings**. -1. Navega hasta la sección GitHub Pages. -1. Haz clic en **Choose a theme**. -1. Decide qué tema te gustaría usar, y haz clic en **Select theme**. - - > Si no te gustan los temas disponibles, más adelante en el curso veremos cómo puedes crear un sitio web sin usar un tema de GitHub Pages. - -1. Acepta el texto de relleno navegando hasta la parte inferior de la página y haz clic en **Commit Changes**. -1. Tu sitio está publicado en: `USUARIO.github.io/NOMBREREPO`. diff --git a/_includes/activity/github-desktop/01-create-repository.md b/_includes/activity/github-desktop/01-create-repository.md deleted file mode 100644 index 2c102f9a6..000000000 --- a/_includes/activity/github-desktop/01-create-repository.md +++ /dev/null @@ -1,18 +0,0 @@ -[//]: # "This is used in both the CLI and Desktop course" - -Now that you have what you need for Git and GitHub installed locally, let's create the repository that will hold your new website. - -![gif of following the directions below](../images/gifs/github-desktop/create-repo.gif) - -1. On GitHub.com, [create a new repository](https://github.com/new). -1. Name your repository `YOUR-USERNAME.GITHUB.IO` - - > The name of your repository will be part of the link to your website. If you use the naming convention we described, your web site will be served at that URL. - -1. Enter a description for your repository. -1. Choose **Public** visibility. - - > We recommend you create a public repository. Public repositories are free. Even if you select a private repository, your published website will be public. - -1. Select **Initialize this repository with a README**. -1. Click **Create repository**. diff --git a/_includes/activity/github-desktop/07-merge-pull-request.md b/_includes/activity/github-desktop/07-merge-pull-request.md deleted file mode 100644 index 70df9c5ab..000000000 --- a/_includes/activity/github-desktop/07-merge-pull-request.md +++ /dev/null @@ -1,8 +0,0 @@ -[//]: # "This is used in both the CLI and Desktop course" - -Since this is your repository, you probably don't have anyone to collaborate with (yet). Go ahead and merge your Pull Request now. - -![gif of following the directions below](../images/gifs/github-desktop/merge-pr.gif) - -1. On GitHub.com, navigate to the Pull Request that you just opened. -1. Scroll down and click the big green **Merge Pull Request** button. diff --git a/_includes/activity/github-desktop/12-add-class-repo.md b/_includes/activity/github-desktop/12-add-class-repo.md deleted file mode 100644 index 2511b6365..000000000 --- a/_includes/activity/github-desktop/12-add-class-repo.md +++ /dev/null @@ -1,5 +0,0 @@ -[//]: # "This is used in both the CLI and Desktop course" - -1. Visit the [class repository](https://github.com/githubschool/on-demand-github-pages/). -1. Click the **Issues** tab. -1. Request push access by [creating an Issue](https://github.com/githubschool/on-demand-github-pages/issues/). diff --git a/_includes/activity/github-desktop/15-collaborate-prs.md b/_includes/activity/github-desktop/15-collaborate-prs.md deleted file mode 100644 index 4bd8201fd..000000000 --- a/_includes/activity/github-desktop/15-collaborate-prs.md +++ /dev/null @@ -1,7 +0,0 @@ -[//]: # "This is used in both the CLI and Desktop course" - -It's now time to collaborate with other learners taking this class around the world :earth_americas:. - -1. In the [class repository on GitHub.com](https://github.com/githubschool/on-demand-github-pages/), navigate to the [Pull Requests tab](https://github.com/githubschool/on-demand-github-pages/pulls). -1. Look through other pull requests. Do they look like good changes, with CI passing? Feel free to post an encouraging message! -1. In your own pull request, wait to see if the branch passes the Travis CI tests and is ready to merge. diff --git a/_includes/activity/github-desktop/16-merge-pr.md b/_includes/activity/github-desktop/16-merge-pr.md deleted file mode 100644 index 1b9e765a7..000000000 --- a/_includes/activity/github-desktop/16-merge-pr.md +++ /dev/null @@ -1,18 +0,0 @@ -[//]: # "This is used in both the CLI and Desktop course" - -Now that your tests have passed, let's click the big green button to add your site to our directory! - -![gif of following the directions below](../images/gifs/github-desktop/merge.gif) - -1. On GitHub.com, check to ensure the tests are passing. -1. Click on **Merge**. -1. Click **Confirm Merge**. -1. Delete the branch. - -## :tada: Congratulations! - -Once you have merged your pull request, you have completed the GitHub workflow! Refresh this page to see your addition to our contribution graph! - -
-
-
diff --git a/_includes/activity/github-desktop/choose-a-theme.md b/_includes/activity/github-desktop/choose-a-theme.md deleted file mode 100644 index d4f19b6cf..000000000 --- a/_includes/activity/github-desktop/choose-a-theme.md +++ /dev/null @@ -1,16 +0,0 @@ -[//]: # "This is used in both the CLI and Desktop course" - -This course is going to use GitHub Pages to create your website. To initialize GitHub Pages we need to perform a few more steps: - -![gif of following the directions below](../images/gifs/github-desktop/choose-a-theme.gif) - - -1. In your newly created repository, click the **Settings** tab. -1. Scroll down to the GitHub Pages section. -1. Click **Choose a theme**. -1. Decide which theme you would like to use, and click **Select theme**. - - > If you don't like the themes available, later in the course we identify how you can build a website without using a GitHub Pages theme. - -1. Accept the filler text by scrolling to the bottom of the page and click on **Commit Changes**. -1. Your site is published at: `USERNAME.github.io/REPONAME`. diff --git a/_includes/activity/github-desktop/desktopsurvey.md b/_includes/activity/github-desktop/desktopsurvey.md deleted file mode 100644 index 031a20c04..000000000 --- a/_includes/activity/github-desktop/desktopsurvey.md +++ /dev/null @@ -1,2 +0,0 @@ -## We Love Feedback :heart: - Please take _literally less than a minute_ to let us know what you think of this course. You may also choose to opt-in for updates on future classes. [Start Survey](https://www.surveygizmo.com/s3/3288550/desktop)! diff --git a/_includes/activity/intro-to-github-es/00-crear-cuenta-github.md b/_includes/activity/intro-to-github-es/00-crear-cuenta-github.md deleted file mode 100644 index 04884acb4..000000000 --- a/_includes/activity/intro-to-github-es/00-crear-cuenta-github.md +++ /dev/null @@ -1,12 +0,0 @@ -Para esta clase, necesitarás una cuenta en GitHub.com. - -Si ya tienes una cuenta en GitHub.com estás listo para empezar. Si no, puedes obtener tu cuenta gratuita siguiendo estos pasos: - -![gif of the following directions]({{site.baseurl}}/images/gifs/intro/sign-in.gif) - -1. Accede a [GitHub.com](https://github.com) e introduce un nombre de usuario, dirección de correo electrónico y contraseña en los campos correspondientes, y haz clic en **Sign up for GitHub**. -1. Selecciona la opción **Unlimited public repositories for free** (Repositorios gratuitos ilimitados). -1. Recibirás un correo de verificación en la dirección indicada. -1. Haz clic en el enlace que recibirás en ese correo para completar el proceso de verificación. - -Si te estás preguntado a dónde ir desde aquí, haz clic en **Dime por qué** para un rápido tour de tu panel de usuario. diff --git a/_includes/activity/intro-to-github-es/01-unirte-repo-intro.md b/_includes/activity/intro-to-github-es/01-unirte-repo-intro.md deleted file mode 100644 index b3767265d..000000000 --- a/_includes/activity/intro-to-github-es/01-unirte-repo-intro.md +++ /dev/null @@ -1,7 +0,0 @@ -¡Es hora de ensuciarse las manos! Utiliza estos pasos para acceder a nuestro proyecto compartido: - -![gif of the directions]({{site.baseurl}}/images/gifs/intro/join-repo-make-issue-introduction.gif) - -1. Entra en tu cuenta GitHub. -1. Navega hasta nuestro [proyecto compartido](https://github.com/githubschool/open-enrollment-classes-introduction-to-github/issues/) y haz clic en el botón **New issue**. -1. Introduce un título para tu issue y haz clic en **Submit new issue**. El usuario GitHubTeacher te añadirá automágicamente a nuestro proyecto como colaborador. \ No newline at end of file diff --git a/_includes/activity/intro-to-github-es/02-gestionar-notificaciones.md b/_includes/activity/intro-to-github-es/02-gestionar-notificaciones.md deleted file mode 100644 index 088ef5354..000000000 --- a/_includes/activity/intro-to-github-es/02-gestionar-notificaciones.md +++ /dev/null @@ -1,4 +0,0 @@ -GitHub defaults to over communication and lets you decide what you do and do not want to receive: - -1. Scroll to the top of issue #927. -2. On the right side of the issue, click **Unsubscribe** to stop getting email notifications from this discussion. diff --git a/_includes/activity/intro-to-github-es/03-crear-branch.md b/_includes/activity/intro-to-github-es/03-crear-branch.md deleted file mode 100644 index c56c89d12..000000000 --- a/_includes/activity/intro-to-github-es/03-crear-branch.md +++ /dev/null @@ -1,10 +0,0 @@ -Es hora de que crees un branch (o rama) que utilizarás para añadir tu pin al mapa. Así es como se hace: - -![gif of directions]({{site.baseurl}}/images/gifs/intro/create-branch-intro.gif) - -1. Navega a la pestaña Code en el repositorio de la clase. -2. Haz clic en el desplegable titulado **Branch: master**. -3. En el campo, introduce este nombre único para tu branch: `usuario-ciudad` utilizando tu nombre de usuario y tu ciudad. -4. Haz clic en **Create branch: usuario-ciudad** o presiona Enter para crear tu branch. - -> Cuando empiezas a escribir en el campo branch, debería mostrarse un botón azul. Si no lo hace, no eres aún un colaborador en el proyecto y tienes que crear un issue [aquí](https://github.com/githubschool/open-enrollment-classes-introduction-to-github/issues/). diff --git a/_includes/activity/intro-to-github-es/04-crear-archivo-en-github.md b/_includes/activity/intro-to-github-es/04-crear-archivo-en-github.md deleted file mode 100644 index 288adbc64..000000000 --- a/_includes/activity/intro-to-github-es/04-crear-archivo-en-github.md +++ /dev/null @@ -1,16 +0,0 @@ -Es momento de añadir tu archivo al repositorio: - -![gif of directions]({{site.baseurl}}/images/gifs/intro/working-on-github.gif) - -1. En tu nuevo branch, añade un archivo nuevo con el nombre `_pins/TU-USUARIO.json`. -1. Introduce el siguiente contenido en tu archivo: - - --- - githubHandle: TU-USUARIO - latitude: TU-LATITUD - longitude: TU-LONGITUD - --- - - -1. Navega hasta la parte inferior e introduce un mensaje de commit que describa tu aportación. -1. Haz commit de tu cambio a tu branch. diff --git a/_includes/activity/intro-to-github-es/05-crear-pull-request.md b/_includes/activity/intro-to-github-es/05-crear-pull-request.md deleted file mode 100644 index 24c3c6e99..000000000 --- a/_includes/activity/intro-to-github-es/05-crear-pull-request.md +++ /dev/null @@ -1,20 +0,0 @@ -Ahora que has creado un archivo, vas a crear un Pull Request para mostrar los cambios que propones a las demás personas que están completando este proyecto: - -![gif of directions]({{site.baseurl}}/images/gifs/intro/pull-request-intro.gif) - -1. Navega hasta la pestaña Pull Requests. -2. Haz clic en `New Pull Request`. -3. En el desplegable **base**, selecciona `master`. -4. En el desplegable **compare**, selecciona tu branch. -5. Haz clic en **Create pull request**. -6. Puedes dejar el título por defecto o hacerlo más descriptivo. -7. Utilizando [formato markdown](https://guides.github.com/features/mastering-markdown/) para explicar el trabajo que has hecho en tu branch: - - Resume el cambio propuesto. - - Menciona al equipo de formadores usando `@githubteacher`. - - Utiliza la palabra clave `closes` seguida inmediatamente por el número de tu issue (ej. `closes #3`) para indicar a qué Issue se refiere este Pull Request. Cuando haces esto, el issue se cerrará automáticamente cuando se haga merge del pull request. - - > Los mensajes de Pull Request son una excelente oportunidad para describir los cambios realizados en el proyecto. Por ejemplo, podrías también incluir información explicando el tipo de feedback que te gustaría que te aportaran los demás u ofreciendo a tus colaboradores una idea de tu planificación temporal para el trabajo. - -8. Haz clic en **Preview** para ver qué aspecto tendrá el Pull Request. -9. Asígnate el pull request a ti mismo haciendo clic en **assign to yourself** en la sección Assignees. -10. Haz clic en `Create pull request`. diff --git a/_includes/activity/intro-to-github-es/05a-colaborar-en-pull-request.md b/_includes/activity/intro-to-github-es/05a-colaborar-en-pull-request.md deleted file mode 100644 index 034b2c274..000000000 --- a/_includes/activity/intro-to-github-es/05a-colaborar-en-pull-request.md +++ /dev/null @@ -1,6 +0,0 @@ -:tada: ¡Enhorabuena! Has creado tu Pull Request. Ahora es momento de ponerte el sombrero de colaborador e ir a ayudar a los demás. - -![gif of directions]({{site.baseurl}}/images/gifs/intro/collaborate.gif) - -1. Ahora que se ha creado tu pull request, vuelve a la lista de pull requests para encontrar un pull request abierto -- que no sea el tuyo. -2. Ofrece feedback :loudspeaker: y motivación :tada:. diff --git a/_includes/activity/intro-to-github-es/06-merge-un-pr.md b/_includes/activity/intro-to-github-es/06-merge-un-pr.md deleted file mode 100644 index f14750ea5..000000000 --- a/_includes/activity/intro-to-github-es/06-merge-un-pr.md +++ /dev/null @@ -1,9 +0,0 @@ -Si todas tus comprobaciones están pasando y no tienes ningún cambio solicitado por otros estudiantes, adelante, puedes hacer merge de tu pull request: - -![gif of directions]({{site.baseurl}}/images/gifs/intro/merge-intro.gif) - -1. Abre tu [Pull Request](https://github.com/githubschool/open-enrollment-classes-introduction-to-github/pulls) para hacer merge. -1. Navega hasta la parte inferior del Pull Request y haz clic en el botón **Merge pull request**. -1. Puedes aceptar el mensaje por defecto para el merge commit. -1. Haz clic en **Confirm merge**. -1. Haz clic en **Delete branch** para eliminar el branch, dado que ya no contiene una tarea o variación en la que se esté trabajando. diff --git a/_includes/activity/intro-to-github/00-create-github-account.md b/_includes/activity/intro-to-github/00-create-github-account.md deleted file mode 100644 index a18d17f56..000000000 --- a/_includes/activity/intro-to-github/00-create-github-account.md +++ /dev/null @@ -1,12 +0,0 @@ -For this class, you will need an account on GitHub.com. - -If you already have a Github.com account you are ready to get started. Otherwise, you can set up your free account by following these steps: - -![gif of the following directions](../images/gifs/intro/sign-in.gif) - -1. Access [GitHub.com](https://github.com) and click and enter a username, email address, and password in the supplied field and click **Sign up for GitHub**. -1. Select the **Unlimited public repositories for free** option. -1. You will receive a verification email at the address provided. -1. Click the emailed link to complete the verification process. - -If you are wondering where to go from here, click **Tell me why** for a quick tour of your dashboard. diff --git a/_includes/activity/intro-to-github/01-join-intro-repo.md b/_includes/activity/intro-to-github/01-join-intro-repo.md deleted file mode 100644 index f8f09200c..000000000 --- a/_includes/activity/intro-to-github/01-join-intro-repo.md +++ /dev/null @@ -1,7 +0,0 @@ -It's time to get your hands dirty! Use these steps to access our shared project: - -![gif of the directions]({{site.baseurl}}/images/gifs/intro/join-repo-make-issue-introduction.gif) - -1. Sign in with your GitHub account. -1. Navigate to our [shared project](https://github.com/githubschool/open-enrollment-classes-introduction-to-github/issues/) and click the **New issue** button. -1. Enter a title for your issue and click **Submit new issue**. The GitHubTeacher user will auto-magically add you to our project as a collaborator. diff --git a/_includes/activity/intro-to-github/02-manage-notifications.md b/_includes/activity/intro-to-github/02-manage-notifications.md deleted file mode 100644 index 088ef5354..000000000 --- a/_includes/activity/intro-to-github/02-manage-notifications.md +++ /dev/null @@ -1,4 +0,0 @@ -GitHub defaults to over communication and lets you decide what you do and do not want to receive: - -1. Scroll to the top of issue #927. -2. On the right side of the issue, click **Unsubscribe** to stop getting email notifications from this discussion. diff --git a/_includes/activity/intro-to-github/03-create-branch.md b/_includes/activity/intro-to-github/03-create-branch.md deleted file mode 100644 index c5acd49e8..000000000 --- a/_includes/activity/intro-to-github/03-create-branch.md +++ /dev/null @@ -1,10 +0,0 @@ -It is time to create the branch you will use to add your pin to the map. Here's how you do it: - -![gif of directions](../images/gifs/intro/create-branch-intro.gif) - -1. Navigate to the Code tab in the class repository. -2. Click the drop-down titled **Branch: master**. -3. In the field, enter this unique name for your branch: `your-username-your-city`. -4. Click **Create branch: your-username-your-city** or press the Enter key to create your branch. - -> When you begin typing in the branch field, a blue button should display, if it doesn't, you aren't a collaborator on the project and need to create an issue [here](https://github.com/githubschool/open-enrollment-classes-introduction-to-github/issues/). diff --git a/_includes/activity/intro-to-github/04-create-a-file-on-github.md b/_includes/activity/intro-to-github/04-create-a-file-on-github.md deleted file mode 100644 index 3c2be9f9f..000000000 --- a/_includes/activity/intro-to-github/04-create-a-file-on-github.md +++ /dev/null @@ -1,16 +0,0 @@ -It's time to add your file to the repository: - -![gif of directions](../images/gifs/intro/working-on-github.gif) - -1. In your new branch, add a new file named: `_pins/YOUR-USERNAME.json`. -1. Enter the following content into your file: - - --- - githubHandle: YOUR-USERNAME - latitude: YOUR_LATITUDE - longitude: YOUR_LONGITUDE - --- - - -1. Scroll down and enter a commit message that describes your addition. -1. Commit your change to your branch. diff --git a/_includes/activity/intro-to-github/05-create-a-pull-request.md b/_includes/activity/intro-to-github/05-create-a-pull-request.md deleted file mode 100644 index dea2ecbf4..000000000 --- a/_includes/activity/intro-to-github/05-create-a-pull-request.md +++ /dev/null @@ -1,20 +0,0 @@ -Now that you have created a file, you will create a Pull Request to show your proposed changes to others who are completing this project: - -![gif of directions](../images/gifs/intro/pull-request-intro.gif) - -1. Navigate to the Pull Requests tab. -2. Click `New Pull Request`. -3. In the **base** dropdown, choose `master`. -4. In the **compare** dropdown, choose your branch. -5. Click **Create pull request**. -6. You can leave the default title or make it more descriptive. -7. Use [markdown formatting](https://guides.github.com/features/mastering-markdown/) to explain the work you have done on your branch. - - Summarize your proposed change. - - Mention the training team using `@githubteacher`. - - Use the keywords `closes` immediately followed by your issue number (e.g. `closes #3`)to note which Issue the Pull Request is addressing. When you do this, the issue will be automatically closed when the pull request is merged. - - > Pull Request messages are an excellent opportunity for you to describe the changes you have made to the project. For example, you could also include information explaining the type of feedback you'd like others to give you or providing collaborators an idea of your timeline. - -8. Click **Preview** to see how your Pull Request will look. -9. Assign the pull request to yourself by clicking **assign to yourself** in the Assignees section. -10. Click `Create pull request`. diff --git a/_includes/activity/intro-to-github/05a-collaborate-on-pull-request.md b/_includes/activity/intro-to-github/05a-collaborate-on-pull-request.md deleted file mode 100644 index cddaaa191..000000000 --- a/_includes/activity/intro-to-github/05a-collaborate-on-pull-request.md +++ /dev/null @@ -1,6 +0,0 @@ -:tada: Congratulations! You have created your Pull Request. Now it is time to put your collaborator hat on and go help others! - -![gif of directions](../images/gifs/intro/collaborate.gif) - -1. Now that your pull request has been created, go back to the pull request list to find an open pull request -- other than your own. -1. Provide feedback :loudspeaker: and motivation :tada:. diff --git a/_includes/activity/intro-to-github/06-merge-a-pr.md b/_includes/activity/intro-to-github/06-merge-a-pr.md deleted file mode 100644 index 49b5bbb9d..000000000 --- a/_includes/activity/intro-to-github/06-merge-a-pr.md +++ /dev/null @@ -1,9 +0,0 @@ -If all of your checks are passing and you do not have any requested changes from other students, you can go ahead and merge your pull request: - -![gif of directions](../images/gifs/intro/merge-intro.gif) - -1. Open your [Pull Request](https://github.com/githubschool/open-enrollment-classes-introduction-to-github/pulls) to be merged. -1. Scroll to the bottom of the Pull Request and click the **Merge pull request** button. -1. You can accept the default merge commit message. -1. Click **Confirm merge**. -1. Click **Delete branch** to delete the branch, as it no longer contains unique work. diff --git a/_includes/analytics-providers/custom.html b/_includes/analytics-providers/custom.html deleted file mode 100644 index c34b97ad9..000000000 --- a/_includes/analytics-providers/custom.html +++ /dev/null @@ -1,3 +0,0 @@ - - - \ No newline at end of file diff --git a/_includes/analytics-providers/google-universal.html b/_includes/analytics-providers/google-universal.html deleted file mode 100644 index 3ada6e36c..000000000 --- a/_includes/analytics-providers/google-universal.html +++ /dev/null @@ -1,9 +0,0 @@ - \ No newline at end of file diff --git a/_includes/archive-single.html b/_includes/archive-single.html deleted file mode 100644 index 397258ab5..000000000 --- a/_includes/archive-single.html +++ /dev/null @@ -1,34 +0,0 @@ -{% include base_path %} - -{% if post.header.teaser %} - {% capture teaser %}{{ post.header.teaser }}{% endcapture %} -{% else %} - {% capture teaser %}{{ site.teaser }}{% endcapture %} -{% endif %} - - diff --git a/_includes/attention.html b/_includes/attention.html deleted file mode 100644 index e2544de10..000000000 --- a/_includes/attention.html +++ /dev/null @@ -1,7 +0,0 @@ -{% if page.attention_message %} -
-
- {{page.attention_message | markdownify}} -
-
-{% endif %} diff --git a/_includes/author-profile.html b/_includes/author-profile.html deleted file mode 100644 index 5efe4c84b..000000000 --- a/_includes/author-profile.html +++ /dev/null @@ -1,102 +0,0 @@ -{% include base_path %} - -{% if page.author %} - {% assign author = site.data.authors[page.author] %}{% else %}{% assign author = site.author %} -{% endif %} - -
- -
- {% if author.avatar contains "://" %} - {{ author.name }} - {% else %} - {{ author.name }} - {% endif %} -
- -
-

{{ author.name }}

- {% if author.bio %}

{{ author.bio }}

{% endif %} -
- -
- - -
-
diff --git a/_includes/blue-hero.html b/_includes/blue-hero.html deleted file mode 100644 index acd54de34..000000000 --- a/_includes/blue-hero.html +++ /dev/null @@ -1,25 +0,0 @@ -
-
-

- {% if paginator %} - {{ site.title }}{% unless paginator.page == 1 %} {{ site.data.ui-text[site.locale].page }} {{ paginator.page }}{% endunless %} - {% else %} - {{ page.title | default: site.title | markdownify | remove: "

" | remove: "

" }} - {% endif %} -

- {% if page.excerpt %} -

{{ page.excerpt | markdownify | remove: "

" | remove: "

" }}

- {% endif %} - {% if site.read_time and page.read_time %} -

{% include read-time.html %}

- {% endif %} - {% if page.header.cta_url %} -

{{ page.header.cta_label | default: site.data.ui-text[site.locale].more_label }}

- {% endif %} - {% include translation_buttons.html %} -
- {% if page.header.caption %} - {{ page.header.caption | markdownify | remove: "

" | remove: "

" }}
- {% endif %} - -
diff --git a/_includes/breadcrumbs.html b/_includes/breadcrumbs.html index e60cfce2b..79d242a64 100644 --- a/_includes/breadcrumbs.html +++ b/_includes/breadcrumbs.html @@ -31,19 +31,25 @@ {% for crumb in crumbs offset: 1 %} {% if forloop.first %} {% endif %} {% if forloop.last %} - + {% else %} {% assign i = i | plus: 1 %} {% endif %} {% endfor %} - \ No newline at end of file + diff --git a/_includes/browser-upgrade.html b/_includes/browser-upgrade.html deleted file mode 100644 index e8d8b2625..000000000 --- a/_includes/browser-upgrade.html +++ /dev/null @@ -1,3 +0,0 @@ - \ No newline at end of file diff --git a/_includes/category-list.html b/_includes/category-list.html deleted file mode 100644 index 173d6b873..000000000 --- a/_includes/category-list.html +++ /dev/null @@ -1,30 +0,0 @@ -{% include base_path %} - -{% include base_path %} - -{% case site.category_archive.type %} - {% when "liquid" %} - {% assign path_type = "#" %} - {% when "jekyll-archives" %} - {% assign path_type = nil %} -{% endcase %} - -{% if site.category_archive.path %} - {% comment %} - - - {% endcomment %} - {% capture page_categories %}{% for category in page.categories %}{{ category | downcase }}#{{ category }}{% unless forloop.last %},{% endunless %}{% endfor %}{% endcapture %} - {% assign category_hashes = (page_categories | split: ',' | sort:0) %} - -

- {{ site.data.ui-text[site.locale].categories_label }} - - {% for hash in category_hashes %} - {% assign keyValue = hash | split: '#' %} - {% capture category_word %}{{ keyValue[1] | strip_newlines }}{% endcapture %} - {% unless forloop.last %}, {% endunless %} - {% endfor %} - -

-{% endif %} diff --git a/_includes/comments-providers/custom.html b/_includes/comments-providers/custom.html deleted file mode 100644 index 90993691e..000000000 --- a/_includes/comments-providers/custom.html +++ /dev/null @@ -1,3 +0,0 @@ - - - \ No newline at end of file diff --git a/_includes/comments-providers/discourse.html b/_includes/comments-providers/discourse.html deleted file mode 100644 index bd9c3332a..000000000 --- a/_includes/comments-providers/discourse.html +++ /dev/null @@ -1,14 +0,0 @@ -{% if site.comments.discourse.server %} -{% include base_path %} -{% capture canonical %}{{ site.baseurl }}{% if site.permalink contains '.html' %}{{ page.url }}{% else %}{{ page.url | remove:'index.html' | strip_slash }}{% endif %}{% endcapture %} - - -{% endif %} \ No newline at end of file diff --git a/_includes/comments-providers/disqus.html b/_includes/comments-providers/disqus.html deleted file mode 100644 index b80be9efd..000000000 --- a/_includes/comments-providers/disqus.html +++ /dev/null @@ -1,22 +0,0 @@ -{% if site.comments.disqus.shortname %} - - -{% endif %} diff --git a/_includes/comments-providers/facebook.html b/_includes/comments-providers/facebook.html deleted file mode 100644 index 009dc1c6c..000000000 --- a/_includes/comments-providers/facebook.html +++ /dev/null @@ -1,8 +0,0 @@ -
- \ No newline at end of file diff --git a/_includes/comments-providers/google-plus.html b/_includes/comments-providers/google-plus.html deleted file mode 100644 index cd582c3dd..000000000 --- a/_includes/comments-providers/google-plus.html +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/_includes/comments.html b/_includes/comments.html deleted file mode 100644 index b59742398..000000000 --- a/_includes/comments.html +++ /dev/null @@ -1,15 +0,0 @@ -{% include base_path %} - -
-

{{ site.data.ui-text[site.locale].comments_label }}

- {% case site.comments.provider %} - {% when "disqus" %} -
- {% when "facebook" %} -
- {% when "google-plus" %} -
Loading Google+ Comments ...
- {% when "custom" %} -
- {% endcase %} -
\ No newline at end of file diff --git a/_includes/footer.html b/_includes/footer.html index aefe1cb01..c76945977 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -1,11 +1,18 @@ -