Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update creating-a-github-pages-site-with-jekyll.md #35092

Merged
merged 2 commits into from
Nov 7, 2024

Conversation

textractor
Copy link
Contributor

The jekyll new --skip-bundle . step should happen in the root directory. The previous step said to cd docs but seems that's not necessary? But if you're still in the docs directory (from the previous step), you'll create the site in the wrong place.

Alternatively, remove the cd docs command if it's really not needed.

Why: To ensure that a command is run in the right directory

Closes:

What's being changed (if available, include any code snippets, screenshots, or gifs):

A step is being made clearer.

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

The `jekyll new --skip-bundle .` step should happen in the root directory. The previous step said to `cd docs` but seems that's not necessary? But if you're still in the docs directory (from the previous step), you'll create the site in the wrong place.

Alternatively, remove the `cd docs` command if it's really not needed.
Copy link

welcome bot commented Oct 29, 2024

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 29, 2024
Copy link
Contributor

github-actions bot commented Oct 29, 2024

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review pages Content related to GitHub Pages and removed triage Do not begin working on this issue until triaged by the team labels Oct 29, 2024
@nguyenalex836
Copy link
Contributor

@textractor Thanks so much for opening a PR! I'll get this triaged for review ✨

@subatoi subatoi added the needs SME This proposal needs review from a subject matter expert label Oct 30, 2024
Copy link
Contributor

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀

@nguyenalex836 nguyenalex836 added SME reviewed An SME has reviewed this issue/PR and removed waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert labels Nov 7, 2024
@nguyenalex836
Copy link
Contributor

@textractor Thanks so much for opening your patience while our SME team reviewed! They've approved your changes ✨ I'll update the branch and get this merged once tests are passing 🍏

If you're looking for an issue to pick up, take a look at our help wanted section to find open issues you can work on ✨

@nguyenalex836 nguyenalex836 added this pull request to the merge queue Nov 7, 2024
Merged via the queue into github:main with commit a6d1ef2 Nov 7, 2024
44 checks passed
Copy link
Contributor

github-actions bot commented Nov 7, 2024

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team pages Content related to GitHub Pages SME reviewed An SME has reviewed this issue/PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants