jekyll / github-metadata

Jekyll plugin to propagate the `site.github` namespace and set default values for use with GitHub Pages.
https://jekyll.github.io/github-metadata/
MIT License
282 stars 127 forks source link

Docs: use plugins config key #114

Closed first-timers[bot] closed 7 years ago

first-timers[bot] commented 7 years ago

πŸ†•πŸ₯☝ First Timers Only.

This issue is reserved for people who never contributed to Open Source before. We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you πŸ’

About First Timers Only.

πŸŽƒπŸ’»πŸ‘• Hacktoberfest: Trick or Treat!

If you haven’t yet, sign up for Hacktoberfest to earn an exclusive T-Shirt. Plus I’m sure we can teach you a cool trick or two in the process

πŸ€” What you will need to know.

Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.

πŸ“‹ Step by Step

@@ -10,15 +10,18 @@ Access `site.github` metadata anywhere (...you have an internet connection).
 Usage of this gem is pretty straight-forward. Add it to your bundle like this:

 ```ruby
-gem 'jekyll-github-metadata'
+gem "jekyll-github-metadata"

Now add it to your _config.yml:

-gems: ['jekyll-github-metadata']
+plugins:
+  - "jekyll-github-metadata"

+:warning: If you are using Jekyll < 3.5.0 use the gems key instead of plugins. + Then go ahead and run bundle install. Once you've done that jekyll-github-metadata will run when you run Jekyll.

In order for jekyll-github-metadata to know what metadata to fetch it must



- [ ] πŸ’Ύ **Commit** your changes

- [ ] πŸ”€ **Start a Pull Request**. There are two ways how you can start a pull request:

1. If you are familiar with the terminal or would like to learn it, [here is a great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) on how to send a pull request using the terminal.

2. You can [edit files directly in your browser](https://help.github.com/articles/editing-files-in-your-repository/)

- [ ] 🏁 **Done** Ask in comments for a review :)

### πŸ€”β“ Questions

Leave a comment below!

This issue was created by [First-Timers-Bot](https://github.com/hoodiehq/first-timers-bot).
Pilabio commented 7 years ago

Want to claim this issue

pathawks commented 7 years ago

Awesome! Thanks @Pilabio :+1:

Pilabio commented 7 years ago

@pathawks Hi sir! So... I cloned the repository to my PC, created a new branch named readme-edit, edited the README.md file making the changes requested (at least what I understood of them...), add the changes and commited them. But it's not showing anywhere, what am I missing? Thanks in advance!!

pathawks commented 7 years ago

First you will need to fork this repository by clicking the Fork button on the repo's homepage. This will create a copy of the repository that you have access to. Next, you will need to add this repository as a remote in your local Git repository. You can get the address by going to your forked repository's homepage and clicking the green Clone or Download button. Copy that URL, and use it to add a remote to your local repo.

If you are using the command line, you can add a remote repository with the command: (using your URL, of course)

git remote add origin https://github.com/Pilabio/github-metadata

Once you have added the remote GitHub repository, you will need to push your local changes to GitHub. From the command line, issue the command:

git push origin readme-edit

Now, the changes are on GitHub and all that is left is to open a Pull Request.

In a web browser, go back to your forked repository on GitHub. With a bit of luck, you should already see a banner at the top of the page inviting you to open a pul request with your recently pushed changes. If this banner does not appear, click the Branches button in the header, find and open the readme-edit branch, then click the New pull request button towards the top of the page.

Let us know if you have any more questions :+1:

pathawks commented 7 years ago

Looks like the issue template gets really nasty if the diff contains triple-backtick code blocks. https://github.com/hoodiehq/first-timers-bot/issues/174

/cc: @jekyll/core @jekyll/ecosystem

Pilabio commented 7 years ago

well I got your instructions and am already making the fork, but I didn't really got what you meant with the diff post, I saw on the template that there's a triple-backtick code block before the diff, and it shows on red what has been removed and on green what has changed, but I didn't see the nasty part...

Pilabio commented 7 years ago

After that the next change is strange indeed, it shows on green and blue. Is that what you meant?

pathawks commented 7 years ago

So sorry about that. I think the diff is supposed to look more like this: 2dc3122e4c5e329557c9fbf903b495d4e6fd87e7

Pilabio commented 7 years ago

@pathawks Good morning sir! Did everything you said and all, but when I tried to Open a new pull request, it shows me this https://travis-ci.org/jekyll/github-metadata/builds/300604584?utm_source=github_status&utm_medium=notification

pathawks commented 7 years ago

Fixed via #115

CI is failing because Rubocop, nothing to do with this.

Thanks again @Pilabio

Pilabio commented 7 years ago

Thank you for the oportunity!