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 README.md #401

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

Update README.md #401

wants to merge 3 commits into from

Conversation

sana-malik
Copy link

@sana-malik sana-malik commented Aug 19, 2022

Update instructions for local installation.

Description

  1. Fix the example URL
  2. Clarify node versions needed to install

Related Issue

n/a

Motivation and Context

This is to help users install their microsites locally for faster development.

How Has This Been Tested?

Practiced install with users.

Screenshots (if appropriate):

n/a

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Copy link

@andrewchough andrewchough left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just had a few comments but nothing blocking! Thanks @sana-malik!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
sana-malik and others added 2 commits August 19, 2022 13:04
Co-authored-by: Andrew Chough <8335579+andrewchough@users.noreply.github.com>

For local:

```
GATSBY_SITE_PATH_PREFIX = Demo

# Personal access token with read access created from github as per instructions [here](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line)
# Personal access token with read access created from Github Enterprise (https://git.corp.adobe.com)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this has to be GitHub Enterprise, does it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants