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

docs: update getting-started.md #1003

Merged
merged 2 commits into from
Aug 24, 2023
Merged

docs: update getting-started.md #1003

merged 2 commits into from
Aug 24, 2023

Conversation

Kimjipang
Copy link
Contributor

Copy link
Contributor

@Haroenv Haroenv left a comment

Choose a reason for hiding this comment

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

good addition, I think it could maybe have a bit more content, what do you think?

@@ -157,3 +153,15 @@ If you are using GitHub Actions, you need to setup the NPM token to release pack
4. Click "Add a new secret".
- Name: `NPM_AUTH_TOKEN`
- Value: Paste the token from clipboard.

## Setup with 'Nothing'
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## Setup with 'Nothing'
## Setup for manual release

Copy link
Contributor Author

@Kimjipang Kimjipang Aug 21, 2023

Choose a reason for hiding this comment

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

First of all, I appreciate for your comment!! Are you saying that "set up for manual release" is more appropriate than "set up with nothing"?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, I think "set up with nothing" isn't totally clear, as your use case is when you don't have CI and release from your computer. I think the guide can reflect that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I completely agree with you. How about adding a little more content? I think this is more explicit. 'set up for manual release(when 'Nothing' is selected in CI configure)'. Because as you know, the first time you run the 'shipjs setup' command, you can choose between 'Circle CI', 'Github Actions', and 'Nothing'.

Copy link
Contributor

Choose a reason for hiding this comment

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

I forgot setup calls it "nothing", lgtm!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It was pleasure to contribute! I wonder how do I add in contributor list. Do I run the command in this url? - https://community.algolia.com/shipjs/guide/contributing.html#working-on-code

Copy link
Contributor

Choose a reason for hiding this comment

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

yes, go ahead @Kimjipang, hope to see more of your contributions :)

website/guide/getting-started.md Show resolved Hide resolved
@Haroenv Haroenv merged commit 34486ea into algolia:main Aug 24, 2023
2 checks passed
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

2 participants