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 CLI Reference with --site & --base flags #1646

Merged
merged 5 commits into from
Oct 13, 2022
Merged

Conversation

natemoo-re
Copy link
Member

What kind of changes does this PR include?

  • New or updated content

Description

@netlify
Copy link

netlify bot commented Sep 29, 2022

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 78a7395
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/6348410a110d200008d3c25f
😎 Deploy Preview https://deploy-preview-1646--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@sarah11918
Copy link
Member

sarah11918 commented Sep 29, 2022

LGTM, @natemoo-re! Just to make sure docs are coordinated with the feature release properly, because --site already exists, but --base is new, and not yet released...

Either this PR needs to wait on the upstream PR withastro/astro#4917 to merge, and we can apply the merge-on-release label to remind us to wait. OR

We can use the <Since /> component to specify the version of Astro that --base works with (even if it's a future version) and it's less of a concern if Docs are merged before the feature is released. This would look like:

---
setup: |
  import Since from '~/components/Since.astro';
 ---
### `--base`

<Since v="1.4.0" />

(Might we want to do this anyway, in case people on older versions try to use --base ?)

@natemoo-re
Copy link
Member Author

Great catch, @sarah11918! Added the Since label for --base.

Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

Looks good Nate! One comment with how we show these headings. Not entirely happy with my proposed argument names, happy for you to change those if you think something else would be better. (Edit: just saw your naming in the upstream PR and adjusted accordingly.)

@@ -167,6 +168,16 @@ Specifies the path to the config file relative to the project root. Defaults to
astro --config config/astro.config.mjs dev
```

### `--site`
Copy link
Member

Choose a reason for hiding this comment

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

Do these need to indicate the arguments they get passed like we do for --root and --config?

Suggested change
### `--site`
### `--site <url>`


Configures the [`site`](/en/reference/configuration-reference/#site) for your project. Passing this flag will override the `site` value in your `astro.config.mjs` file, if one exists.

### `--base`
Copy link
Member

@delucis delucis Sep 30, 2022

Choose a reason for hiding this comment

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

Suggested change
### `--base`
### `--base <pathname>`

@delucis delucis changed the title Update CLI Reference Update CLI Reference with --site & --base flags Oct 1, 2022
@delucis
Copy link
Member

delucis commented Oct 1, 2022

(added the flags to the PR title so we can test #1653)

@delucis delucis added the merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) label Oct 5, 2022
@sarah11918 sarah11918 merged commit 2a5c454 into main Oct 13, 2022
@sarah11918 sarah11918 deleted the feat/update-cli-refs branch October 13, 2022 17:12
@sarah11918 sarah11918 added the minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah! label Jun 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) minor-release For the next minor release; in the milestone, "merge queue" when approved by Sarah!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants