Giter Club home page Giter Club logo

github-pages's Introduction

Learning Lab bot

Course: GitHub Pages

This repository powers the Learning Lab course GitHub Pages.

Every Learning Lab course is made up of:

The course repository is written in YAML and Markdown. The template repository could be written in any language that supports the learning objectives.

For more information on the goals of this course, check out the course-details.md.

Contribute

See something we could improve? Check out the contributing guide in the community contributors repository for more information on the types of contributions we ❤️ and instructions.

We ❤️ our community and take great care to ensure it is fun, safe and rewarding. Please review our Code of Conduct for community expectations and guidelines for reporting concerns.

License

All Learning Lab course repositories are licensed under CC-BY-4.0 (c) 2019 GitHub, Inc. The template repositories associated with each course may have different licenses.

When using the GitHub logos, be sure to follow the GitHub logo guidelines

github-pages's People

Contributors

a-a-ron avatar beardofedu avatar brianamarie avatar carolynshin avatar crichid avatar hectorsector avatar heiskr avatar hollenberry avatar jamesmgreene avatar jasonetco avatar mirenbz avatar parkerbxyz avatar rfosu2k2 avatar yhkee0404 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

github-pages's Issues

Update server install instructions to include minima repos in certain cases

Bug Report

Current behavior

As reported by a user:

In the GitHub Pages course, It has you update your user ID in the config. It then uses that to create a link to your GitHub profile on the bottom of the blog post page. I think that link should point to your GHE instance instead of GitHub.com if you’re running the course from GHES.

The minima theme automatically generates the link to point to github.com in: https://github.com/jekyll/minima/blob/aeab39123d8b5f853bc2427c0d72318a2b5055bd/_includes/social.html#L8

Possible solution

We could look at the other packaged themes: https://pages.github.com/themes/ to see if switching would fix the problem.

/cc @amyschoen @brianamarie @hectorsector

Add support for Git LFS

Feature Request

Describe the problem/friction you are trying to solve
Currently, GitHub Pages does not load content properly when said content is hosted by Git LFS. (for example, https://radzo73.github.io/fparchive/FPAW1.html loads its Flash .swf just fine because the .swf isn't hosted on Git LFS, but https://radzo73.github.io/fparchive/FPAW3.html doesn't load its Flash .swf properly because its .swf is hosted with Git LFS)

Describe your ideal solution.
Git LFS support, so files on my GitHub Page load properly (for example, again, https://radzo73.github.io/fparchive/FPAW3.html would load its Flash .swf properly if Git LFS support was added.)

Drawbacks: None?

Describe alternatives you have considered.
Adding/using alternatives to Git LFS (nothing that I know of)

Homepage titles printed twice

Bug Report

Current behavior
Homepage titles are redundantly printed twice. The course description also shows a screen capture where the page title Welcome to my blog is printed twice.

## What you'll build
In this course, you'll build a simple personal blog site with GitHub Pages. You'll be able to add posts and share your blog with anyone.
![Screenshot_2020-02-25 Welcome to my blog](https://user-images.githubusercontent.com/1221423/75267083-224fd180-57a8-11ea-8acf-64c1ee6d950f.png)

Screenshot_2020-02-25 Welcome to my blog

Reproduction
Steps to reproduce the behavior in the course:

  1. Follow the course steps up to Step 4: Customize Site Details, keeping index.md beginning with a heading. For example, the default file begins with # Welcome to my blog.
  2. Click the link to the published page, represented as [here]({{ deploymentUrl }}):
    ## Step 4: Customize Site Details
    Great work! You can see your published page [here]({{ deploymentUrl }}). If you don't see your changes right away, refresh the page.
  3. See the beginning heading, e.g. Welcome to my blog, replicating itself twice.

Expected behavior
It is enough to print it just once like this:
B4DBB53D-91A9-4E50-A0D8-3D25E3CAD999

Possible solution
Replace the default beginning heading # Welcome to my blog in index.md with a front matter like this:

-# Welcome to my blog
+---
+title: “Welcome to my blog”
+---

I’m glad you are here. I plan to talk about …

Or just delete the number sign (#) of the beginning heading to make sure that index.md do not begin with a heading.

Additionally, add an instruction like “Write your homepage title in a front matter.” or a warning like “Make sure that index.md do not begin with a heading without a page title front matter.” to responses/01_update-index.md where users update index.md.

Your repository has an `index.md` file so we can update it to include your personalized content.
### :keyboard: Activity: Create your homepage
1. Navigate to the **Code** tab of this repository, and browse to the `index.md` file, or click this link [here]({{ repoUrl }}/blob/main/index.md)
2. In the upper right corner, click the ![octicon-pencil] icon to edit the `index.md` file
3. Type the content you want on your homepage

Additional context
I found the same issue and solution here and here.

I also made a post on Github Community Forum.

The Class Completes Successfully Even with Pages Compilation Error

Bug Report

Current behavior
The course doesn't detect compilation errors in jekyll.

Reproduction
Steps to reproduce the behavior in the course:

Step 4: Customize Site Details

  1. Start the value for github_username in _config.yaml with an @.
  2. Finish the rest of the instructions and eventually merge in the PR.
  3. You receive an email notification that looks like this:
The page build failed for the `master` branch with the following error:
You have an error on line 9 of your `_config.yml` file. For more information, see https://help.github.com/enterprise/2.19/user/en/articles/troubleshooting-jekyll-build-errors-for-github-pages-sites#config-file-error.
For information on troubleshooting Jekyll see:
  https://help.github.com/enterprise/2.19/user/articles/troubleshooting-jekyll-builds
If you have any questions you can contact us by replying to this email.
  1. The course still congratulates you on successful completion.

Expected behavior
I would expect that an issue with the config file would not lead to successful course completion.

Possible solution
Find some way of detecting that pages didn't get deployed correctly and have them go back and edit.

Additional context
N/A

/cc @crichID @brianamarie @hectorsector @JasonEtco

Test - Happy Path (7/4/18)

Bugs

  • Lab step 2 has a typo in hompage
  • Step 2 does not link to the next pull request
  • Step 2 does not automatically close after successful completion
  • Step 3 does not respond after successful completion.
  • Lab does not update following step 2.
  • General thoughts - I think this course could use polish updates similar to the Communicating with Markdown course
    • PRs automatically opened with specific files ready for edit

cc: @JasonEtco

Bug Report: Post not showing up

Bug Report

Current behavior
Post not showing up.

Reproduction
Steps to reproduce the behavior in the course:

  1. Go to this issue: carolynshin/github-pages-with-jekyll#4, which tells me that I successfully completed the course.
  2. Go to my page: https://carolynshin.github.io/github-pages-with-jekyll/
  3. See error: No post

Expected behavior
I expected my post to show up on my page but I do not see it.

Possible solution
N/A

Additional context
Another user on the learning lab community forum experienced this problem. It is most likely because there are issues with their post - they didn't add a space between the date and the date value, and it looks like they added their blog content inside the frontmatter. I was testing out this course to see if it fixed the user's issue and couldn't get my post to work either.

/cc: @hectorsector and @a-a-ron

Can't get past "Customize your homepage step"

When attempting to get past the Customize your homepage step, I see the following error on my terminal:

  Error in customize-your-homepage:gate[2] TypeError: Cannot read property 'findIndex' of undefined
      at Object.includes (/Users/hec/github/learning-lab/lib/actions/gate/index.js:32:14)
      at evaluate (/Users/hec/github/learning-lab/lib/actions/gate/index.js:43:32)
      at opts.gates.some.gate (/Users/hec/github/learning-lab/lib/actions/gate/index.js:54:14)
      at Array.some (<anonymous>)
      at Object.module.exports [as gate] (/Users/hec/github/learning-lab/lib/actions/gate/index.js:52:26)
      at Context.module.exports (/Users/hec/github/learning-lab/lib/utils/run-action.js:26:23)
      at module.exports (/Users/hec/github/learning-lab/lib/utils/run-actions.js:6:37)
      at <anonymous>
      at process._tickDomainCallback (internal/process/next_tick.js:228:7)

It also appears the step isn't being marked complete in the dash, although the PR is approved.

This seems to be related to this portion of the config:

github-pages/config.yml

Lines 33 to 52 in cccc2c1

- title: "Customize your homepage"
description: "Open a pull request with changes to the hompage."
event: "pull_request.opened"
link: "https://github.com/{{ user.username }}/{{ course.template.name }}/issues"
actions:
- type: gate
left: '%payload.pull_request.body%'
required: false
else:
type: respond
with: 06a_pull-request-blank.md
- type: getTree
- type: gate
gates:
- left: '%actions[1].data.tree%'
operator: includes
right: 'path:index.html'
- left: '%actions[1].data.tree%'
operator: includes
right: 'path:index.md'

Test - Happy Path (7/5/18)

Bugs

  • Step 2 links to a broken website
  • Step 4 does not prompt the user with next steps after successful completion (lab updates correctly and new issue is generated)
  • Step 5/6 does not leave a review on the open PR.

cc: @JasonEtco

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.