From 26bcc9541916eccc23dfe8e9cc9dd45a3289e489 Mon Sep 17 00:00:00 2001 From: confused-Techie Date: Sun, 29 Jan 2023 16:51:28 -0800 Subject: [PATCH 01/50] Basic skeleton of Launch Manual v2 --- docs/docs/launch-manual-v2/index.md | 13 +++++++++ .../sections/authoring-packages/index.md | 27 +++++++++++++++++++ pnpm-lock.yaml | 6 ++--- 3 files changed, 43 insertions(+), 3 deletions(-) create mode 100644 docs/docs/launch-manual-v2/index.md create mode 100644 docs/docs/launch-manual-v2/sections/authoring-packages/index.md diff --git a/docs/docs/launch-manual-v2/index.md b/docs/docs/launch-manual-v2/index.md new file mode 100644 index 000000000..348d087db --- /dev/null +++ b/docs/docs/launch-manual-v2/index.md @@ -0,0 +1,13 @@ +--- +title: Launch Manual v2 +--- + +Here you will find the V2 of the Launch Manual. A redisgined and reimagined way to browse and read our documentation. With the goal of being easier than before to understand, skim, and consume. + +Currently this page is not linked on the sidebar as it is nowhere near complete. But if you've found the page by accident feel free to click onto the standard Launch Manual on the sidebar as the documentation there is complete. + +Otherwise with that said lets get onto our docs. + +## [Authoring Pulsar Packages](/docs/launch-manual-v2/sections/authoring-packages) + +Authoring Pulsar Packages will walk you through the basics of creating your Pulsar Packages and Publishing them to the Pulsar Package Registry. This is where you should go if you'd like to become one of the amazing community members to publish and maintain a package for everyone to use. diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/index.md b/docs/docs/launch-manual-v2/sections/authoring-packages/index.md new file mode 100644 index 000000000..30146103b --- /dev/null +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/index.md @@ -0,0 +1,27 @@ +--- +lang: en-US +title: Authoring Pulsar Packages +description: Creating and Publishing Packages for Pulsar Package Registry +--- + +# Authoring Pulsar Packages + +Here we will focus on the "Hackable" part of the Hyper-Hackable Editor. As well as take a look at how to get your package listed on the Pulsar Package Registry. As we've seen and you've probably noticed a huge part of Pulsar is made up of bundled and community made packages. If you wish to add some functionality to Pulsar, you have access to the same APIs and tools that the core features of Pulsar has. From the [tree-view](https://github.com/pulsar-edit/tree-view) to the [command-palette](https://github.com/pulsar-edit/command-palette) functionality, even the most core features of Pulsar are implemented as packages. + +In this section we will cover how to extend the functionality of Pulsar through writing packages. This will be everything from new user interfaces to new language grammars to new themes. We'll learn this by writing a series of increasinly complex packages together, introducing you to new APIs and tools and techniques as we need them. + +Additionally we will then take a look at how we can get your packages published to the Pulsar Package Registry using the built in tool PPM to do so. + +--- + +If you are just jumping in here are some resources you may want to keep handy to get yourself familair with the other parts of Pulsar we will be using here. + +- [Pulsar Package Registry API]() +- [Pulsar Editor API]() +- [Using PPM]() + +--- + +::: details Sections + +::: diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index d3cd2bb38..2b98c28de 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -20,7 +20,7 @@ specifiers: vuepress-theme-hope: 2.0.0-beta.106 dependencies: - .github: github.com/pulsar-edit/.github/be58e3e9aa5243419278b508da531db52bd67258 + .github: github.com/pulsar-edit/.github/971cb20aa1a7039e73d399ceaf9eb8a6d3bc4971 pulsar-assets: github.com/pulsar-edit/pulsar-assets/8fb8c787c296b789d5eea8dd65ea20c7a2af759d vuepress-theme-hope: 2.0.0-beta.106 @@ -7072,8 +7072,8 @@ packages: resolution: {integrity: sha512-JZxotl7SxAJH0j7dN4pxsTV6ZLXoLdGME+PsjkL/DaBrVryK9kTGq06GfKrwcSOqypP+fdXGoCHE36b99fWVoA==} dev: true - github.com/pulsar-edit/.github/be58e3e9aa5243419278b508da531db52bd67258: - resolution: {tarball: https://codeload.github.com/pulsar-edit/.github/tar.gz/be58e3e9aa5243419278b508da531db52bd67258} + github.com/pulsar-edit/.github/971cb20aa1a7039e73d399ceaf9eb8a6d3bc4971: + resolution: {tarball: https://codeload.github.com/pulsar-edit/.github/tar.gz/971cb20aa1a7039e73d399ceaf9eb8a6d3bc4971} name: .github version: 0.0.0 dev: false From 7f95b6cac74c3279ab6e4c4aa98c62720ff665ca Mon Sep 17 00:00:00 2001 From: confused-Techie Date: Sun, 29 Jan 2023 17:26:04 -0800 Subject: [PATCH 02/50] Publishing Package Docs --- .../sections/authoring-packages/index.md | 4 ++ .../sections/publishing-a-package.md | 71 +++++++++++++++++++ 2 files changed, 75 insertions(+) create mode 100644 docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/index.md b/docs/docs/launch-manual-v2/sections/authoring-packages/index.md index 30146103b..69485e268 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/index.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/index.md @@ -24,4 +24,8 @@ If you are just jumping in here are some resources you may want to keep handy to ::: details Sections +- [Publishing a Package](#publishing-a-package) + ::: + +@include(sections/publishing-a-package.md) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md new file mode 100644 index 000000000..00cc25d13 --- /dev/null +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md @@ -0,0 +1,71 @@ +## Publishing a Package + +Pulsar bundles a command line utility called `ppm` which we first used back in [Command Line](../../../using-pulsar/#command-line) to search for and install packages via the command line. This is invoked by using the `pulsar` command with the `-p` or `--package` option. The `pulsar -p` command can also be used to publish packages to the Pulsar Package Registry and to update them. + +See more in the [PPM Docs]() section. + +### Prepare Your Package + +There are a few important things to double check before publishing your package: + +- Your `package.json` file has a `name`, `description`, and `repository` fields. +- Your `package.json` `name` field is URL Safe, as in it doesn't include an emoji or special character. +- Your `package.json` `version` field is [Semver V2](https://semver.org/spec/v2.0.0.html) compliant. +- Your `package.json` `engines` field contains an entry for `atom` such as: `"enginges": { "atom": ">=1.0.0 <2.0.0"}`. +- Your package has a `README.md` file at it's root. +- Your `repository` URL in the `package.json` file is the same as the URL of your repository on GitHub. +- Your package is in a git repository that has been pushed to [GitHub](https://github.com). Follow [this guide](https://help.github.com/articles/importing-a-git-repository-using-the-command-line/) if your package isn't already on GitHub. + +### Publishing Your Package + +Before you publish a package it is a good idea to check ahead of time if a +package with the same name has already been published to +[the Pulsar Package Repository](https://web.pulsar-edit.dev/packages). You can +do that by visiting `https://web.pulsar-edit.dev/packages/your-package-name` to +see if the package already exists. If it does, update your package's name to +something that is available before proceeding. + +Now let's review what the `pulsar -p publish` command does: + +1. Registers the package name on Pulsar Package Repository if it is being + published for the first time. +2. Updates the `version` field in the `package.json` file and commits it. +3. Creates a new [Git tag](https://git-scm.com/book/en/Git-Basics-Tagging) for + the version being published. +4. Pushes the tag and current branch up to GitHub. +5. Updates Pulsar Package Repository with the new version being published. + +Now run the following commands to publish your package: + +```sh +$ cd path-to-your-package +$ pulsar -p publish minor +``` + +If this is the first package you are publishing, the `pulsar -p publish` command may prompt you for your GitHub username and password. If you have two-factor authentication enabled, use a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) in lieu of a password. This is required for PPM to automatically manage and push tags to your package's GitHub repo and is needed only during the first time publishing. The credentials are stored securely in your [keychain]() once you login. + +Additionally if this is your first time publishing to the Pulsar Package Registry, you also need to provide PPM an API token to access your Pulsar User Account. If you don't have a Pulsar User Account already, you'll need to make one on the [Pulsar Website](https://web.pulsar-edit.dev/login). You can learn more about creating an account on the [Pulsar Website Docs](). Once you have successfully created an account copy the API token available on your user page and use `pulsar -p --login ` to give PPM your API Key. Again just like your GitHub credentials this API Key is stored securely in your [keychain](). + +Now your package is published and available on the Pulsar Package Registry. Head on over to `https://web.pulsar-edit.dev/packages/your-package-name` to see your package's page. + +With `pulsar -p publish`, you can bump the version and publish by using + +```sh +$ pulsar -p publish +``` + +Where `version-type` can be `major`, `minor`, and `patch`. + +- **MAJOR** version when you make incompatible API changes. +- **MINOR** version when you add functionality in a backwards compatible manner. +- **PATCH** version when you make backwards compatible bug fixes. + +i.e. to bump a package from v1.**0**.0 to v1.**1**.0: + +```sh +$ pulsar -p publish minor +``` + +Check out [semantic versioning](https://semver.org/) to learn more about best practices for versioning your package releases. + +You can also run `pulsar -p help publish` to see all the available options and `pulsar -p help` to see all the other available commands. Or check our the [PPM Docs]() to learn more about using PPM. From 077ff90bcff497b301e7a491e9d7d1cdeec30bf4 Mon Sep 17 00:00:00 2001 From: confused-Techie Date: Sun, 29 Jan 2023 18:46:15 -0800 Subject: [PATCH 03/50] Added Pulsar Package Registry Frontend Website Docs --- docs/docs/launch-manual-v2/index.md | 4 ++ .../sections/authoring-packages/index.md | 2 - .../sections/ppr-frontend/index.md | 21 ++++++ .../sections/pulsar-user-account.md | 71 +++++++++++++++++++ 4 files changed, 96 insertions(+), 2 deletions(-) create mode 100644 docs/docs/launch-manual-v2/sections/ppr-frontend/index.md create mode 100644 docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md diff --git a/docs/docs/launch-manual-v2/index.md b/docs/docs/launch-manual-v2/index.md index 348d087db..7ce430bdc 100644 --- a/docs/docs/launch-manual-v2/index.md +++ b/docs/docs/launch-manual-v2/index.md @@ -8,6 +8,10 @@ Currently this page is not linked on the sidebar as it is nowhere near complete. Otherwise with that said lets get onto our docs. +## [Pulsar Package Registry Frontend Website](/docs/launch-manual-v2/sections/ppr-frontend) + +Detials and Guides to using the Pulsar Package Registry Frontend Website, where you can manage your Pulsar User Account, and browse the available Packages for Pulsar from any device on the web. + ## [Authoring Pulsar Packages](/docs/launch-manual-v2/sections/authoring-packages) Authoring Pulsar Packages will walk you through the basics of creating your Pulsar Packages and Publishing them to the Pulsar Package Registry. This is where you should go if you'd like to become one of the amazing community members to publish and maintain a package for everyone to use. diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/index.md b/docs/docs/launch-manual-v2/sections/authoring-packages/index.md index 69485e268..9c8958729 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/index.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/index.md @@ -4,8 +4,6 @@ title: Authoring Pulsar Packages description: Creating and Publishing Packages for Pulsar Package Registry --- -# Authoring Pulsar Packages - Here we will focus on the "Hackable" part of the Hyper-Hackable Editor. As well as take a look at how to get your package listed on the Pulsar Package Registry. As we've seen and you've probably noticed a huge part of Pulsar is made up of bundled and community made packages. If you wish to add some functionality to Pulsar, you have access to the same APIs and tools that the core features of Pulsar has. From the [tree-view](https://github.com/pulsar-edit/tree-view) to the [command-palette](https://github.com/pulsar-edit/command-palette) functionality, even the most core features of Pulsar are implemented as packages. In this section we will cover how to extend the functionality of Pulsar through writing packages. This will be everything from new user interfaces to new language grammars to new themes. We'll learn this by writing a series of increasinly complex packages together, introducing you to new APIs and tools and techniques as we need them. diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/index.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/index.md new file mode 100644 index 000000000..611e4b6ac --- /dev/null +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/index.md @@ -0,0 +1,21 @@ +--- +lang: en-US +title: Pulsar Package Registry Frontend Website +description: Using and Navigating the Pulsar Package Registry Website +--- + +# Pulsar Package Registry Frontend Website + +The Package Registry Frontend Website viewable on [https://web.pulsar-edit.dev](https://web.pulsar-edit.dev/) is the frontend counterpart to the Pulsar Package Registry. Allowing an easy way for anyone on any platform to view and browse the packages that are available to install on Pulsar. + +While the website isn't much more than a wrapper around the actual Pulsar Package Registry API it does serve a few important purposes for Pulsar. + +::: details Sections + +- [Pulsar User Account](#pulsar-user-account) + +::: + +@include(sections/pulsar-user-account.md) + + diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md new file mode 100644 index 000000000..1f6f7caf4 --- /dev/null +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -0,0 +1,71 @@ +## Pulsar User Account + +A Pulsar User Account enables you to Publish and manage Published Packages to the Pulsar Package Registry, as well as lets you star packages that exist on the Pulsar Package Registry. + +Otherwise for just downloading and using packages from the Pulsar Package Registry no account is required. + +### Creating a Pulsar User Account + +To create a Pulsar User Account you just need to navigate to the Pulsar Package Registry Website and click "Sign In" on the top header bar. +Otherwise you can go directly to [the Signup Page](https://web.pulsar-edit.dev/login). + +Here you can see there's a few choices of how to create your account. + +- [Sign Up with a PAT Token](#sign-up-with-a-pat-token) +- [Sign Up with GitHub OAuth](#sign-up-with-github-oauth) + +#### Sign Up with a PAT Token + +Using a PAT token from GitHub allows you precise control over what permissions your Pulsar User Account has over your GitHub account, which you don't get with the OAuth Signup. + +This way you can go to your GitHub Account and [create your own PAT token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) that is create a Personal Access Token with only the permissions you decide. + +When creating your PAT token it's good to know what scopes should be allowed access to your Pulsar User Account. By default the only scopes needed are: + +- public_repo +- read:org + +Beyond that your Pulsar User Account won't try to use any additional permissions. + +Once your PAT Token is created navigate back to the Pulsar Signup Screen and plug your PAT token into the text box where it says "Enter your GitHub PAT" and click "Sign Up". After a few redirects you should be brought to your [Pulsar User Account Page](https://web.pulsar-edit.dev/users). + +#### Sign Up with GitHub OAuth + +Using GitHub OAuth signup means you don't have to manage the permissions and signup process on your own as opposed to the PAT Token signup. + +Still when signing up with GitHub OAuth the only permissions requested (That you'll be able to review during the process) are: + +- public_repo +- read:org + +These are the only permissions needed for your Pulsar User Account to access all features it's capable of. + +Once you click to "Sign Up with GitHub OAuth" you'll be redirected to GitHub to authorize Pulsar to access your account. There you can check the account you are allowing access, and review the permissions being granted. + +Afterwards you should be redirected to your [Pulsar User Account Page](https://web.pulsar-edit.dev/users). + +#### Managing your Account + +Now that your Pulsar User Account has been successfully created you can manage it on your [Pulsar User Account Page](https://web.pulsar-edit.dev/users). + +Here you can view the account information saved to Pulsar, and view your Pulsar API Token. + +This Pulsar API Token is what can be used to allow you to publish to the Pulsar Package Registry using [PPM](). + +Otherwise if you ever notice your account information here has become out of date (i.e. you've changed your profile picture) you can always click "Log Out" at the top of the page, and sign in again with the same steps as before. When you click go through the sign up process after already having created a Pulsar User Account this just updates your account information with what's most recent from GitHub. + +#### Notes on a Pulsar User Account + +A few important notes about your Pulsar User Account to keep in mind. + +Pulsar greatly respects your privacy, and more than that doesn't want the chance to invade your privacy, or be responsible for your sensitive account credentials. + +That's why when you create a User Account with Pulsar there are only three pieces of information stored about you: + +- Your GitHub Account Username. +- Your GitHub Gravatar Image URL. +- Your GitHub `node_id`. + +Think of your `node_id` like the random number GitHub assigned to your account when you created it. This is a public value that anyone on GitHub can find using the API and doesn't reveal any private details about yourself , your location or your account. Beyond this the Pulsar Backend collects zero information about who you are, and doesn't even save your API Keys itself. + +If you'd like to read more about how your information is used for Pulsar take a look at our [Privacy Policy]() or the [Pulsar Backend]() Documentation. From 93ba2246d7a17e9021c69dc2e8723bd82948d8c0 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:51:33 -0800 Subject: [PATCH 04/50] Update docs/docs/launch-manual-v2/index.md Co-authored-by: Andrew Dupont --- docs/docs/launch-manual-v2/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/index.md b/docs/docs/launch-manual-v2/index.md index 7ce430bdc..0728e952b 100644 --- a/docs/docs/launch-manual-v2/index.md +++ b/docs/docs/launch-manual-v2/index.md @@ -2,7 +2,7 @@ title: Launch Manual v2 --- -Here you will find the V2 of the Launch Manual. A redisgined and reimagined way to browse and read our documentation. With the goal of being easier than before to understand, skim, and consume. +Here you will find version 2 of the Launch Manual. It's a redesigned and reimagined way to browse and read our documentation with the goal of being easier to understand, skim, and consume. Currently this page is not linked on the sidebar as it is nowhere near complete. But if you've found the page by accident feel free to click onto the standard Launch Manual on the sidebar as the documentation there is complete. From 72b8c308d801ba43b9dca10cb1ffd9cf66bf7539 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:51:41 -0800 Subject: [PATCH 05/50] Update docs/docs/launch-manual-v2/index.md Co-authored-by: Andrew Dupont --- docs/docs/launch-manual-v2/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/index.md b/docs/docs/launch-manual-v2/index.md index 0728e952b..43f9df69e 100644 --- a/docs/docs/launch-manual-v2/index.md +++ b/docs/docs/launch-manual-v2/index.md @@ -4,7 +4,7 @@ title: Launch Manual v2 Here you will find version 2 of the Launch Manual. It's a redesigned and reimagined way to browse and read our documentation with the goal of being easier to understand, skim, and consume. -Currently this page is not linked on the sidebar as it is nowhere near complete. But if you've found the page by accident feel free to click onto the standard Launch Manual on the sidebar as the documentation there is complete. +Currently this page is not linked on the sidebar, as it is nowhere near complete. But if you've found the page by accident, feel free to click onto the standard Launch Manual on the sidebar as the documentation there is complete. Otherwise with that said lets get onto our docs. From 936d70d9ccfba40d8a29565f0f23c9d144ed708b Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:51:54 -0800 Subject: [PATCH 06/50] Update docs/docs/launch-manual-v2/index.md Co-authored-by: Andrew Dupont --- docs/docs/launch-manual-v2/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/index.md b/docs/docs/launch-manual-v2/index.md index 43f9df69e..764604785 100644 --- a/docs/docs/launch-manual-v2/index.md +++ b/docs/docs/launch-manual-v2/index.md @@ -6,7 +6,6 @@ Here you will find version 2 of the Launch Manual. It's a redesigned and reimagi Currently this page is not linked on the sidebar, as it is nowhere near complete. But if you've found the page by accident, feel free to click onto the standard Launch Manual on the sidebar as the documentation there is complete. -Otherwise with that said lets get onto our docs. ## [Pulsar Package Registry Frontend Website](/docs/launch-manual-v2/sections/ppr-frontend) From 2aba6472d1428ba9f7863131bbfffb639ba80db0 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:52:16 -0800 Subject: [PATCH 07/50] Update docs/docs/launch-manual-v2/sections/authoring-packages/index.md Co-authored-by: Andrew Dupont --- docs/docs/launch-manual-v2/sections/authoring-packages/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/index.md b/docs/docs/launch-manual-v2/sections/authoring-packages/index.md index 9c8958729..a1236d66c 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/index.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/index.md @@ -6,7 +6,7 @@ description: Creating and Publishing Packages for Pulsar Package Registry Here we will focus on the "Hackable" part of the Hyper-Hackable Editor. As well as take a look at how to get your package listed on the Pulsar Package Registry. As we've seen and you've probably noticed a huge part of Pulsar is made up of bundled and community made packages. If you wish to add some functionality to Pulsar, you have access to the same APIs and tools that the core features of Pulsar has. From the [tree-view](https://github.com/pulsar-edit/tree-view) to the [command-palette](https://github.com/pulsar-edit/command-palette) functionality, even the most core features of Pulsar are implemented as packages. -In this section we will cover how to extend the functionality of Pulsar through writing packages. This will be everything from new user interfaces to new language grammars to new themes. We'll learn this by writing a series of increasinly complex packages together, introducing you to new APIs and tools and techniques as we need them. +In this section we will cover how to extend the functionality of Pulsar through writing packages. Packages can do a number of things: change the user interface, add a new theme, add a grammar for a language, and more. We'll learn this by writing a series of increasingly complex packages together, introducing you to new APIs, tools, and techniques as we need them. Additionally we will then take a look at how we can get your packages published to the Pulsar Package Registry using the built in tool PPM to do so. From 310da849836c0bab8f3eee875a9652998a857368 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:52:54 -0800 Subject: [PATCH 08/50] Update docs/docs/launch-manual-v2/index.md Co-authored-by: Andrew Dupont --- docs/docs/launch-manual-v2/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/index.md b/docs/docs/launch-manual-v2/index.md index 764604785..f0c5293ee 100644 --- a/docs/docs/launch-manual-v2/index.md +++ b/docs/docs/launch-manual-v2/index.md @@ -9,7 +9,7 @@ Currently this page is not linked on the sidebar, as it is nowhere near complete ## [Pulsar Package Registry Frontend Website](/docs/launch-manual-v2/sections/ppr-frontend) -Detials and Guides to using the Pulsar Package Registry Frontend Website, where you can manage your Pulsar User Account, and browse the available Packages for Pulsar from any device on the web. +Guide to using the Pulsar Package Registry, where you can manage your Pulsar user account and browse the available packages for Pulsar from any device on the web. ## [Authoring Pulsar Packages](/docs/launch-manual-v2/sections/authoring-packages) From dc789fc4e5bca9b7b5dbeb291a0ad6df5dbaf441 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:53:23 -0800 Subject: [PATCH 09/50] Update docs/docs/launch-manual-v2/sections/authoring-packages/index.md Co-authored-by: Andrew Dupont --- docs/docs/launch-manual-v2/sections/authoring-packages/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/index.md b/docs/docs/launch-manual-v2/sections/authoring-packages/index.md index a1236d66c..fa2c928d2 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/index.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/index.md @@ -4,7 +4,7 @@ title: Authoring Pulsar Packages description: Creating and Publishing Packages for Pulsar Package Registry --- -Here we will focus on the "Hackable" part of the Hyper-Hackable Editor. As well as take a look at how to get your package listed on the Pulsar Package Registry. As we've seen and you've probably noticed a huge part of Pulsar is made up of bundled and community made packages. If you wish to add some functionality to Pulsar, you have access to the same APIs and tools that the core features of Pulsar has. From the [tree-view](https://github.com/pulsar-edit/tree-view) to the [command-palette](https://github.com/pulsar-edit/command-palette) functionality, even the most core features of Pulsar are implemented as packages. +A huge part of Pulsar is made up of bundled and community-made packages. If you wish to add some functionality to Pulsar, you have access to the same APIs and tools that were used to build Pulsar itself. From the [tree-view](https://github.com/pulsar-edit/tree-view) to the [command-palette](https://github.com/pulsar-edit/command-palette) functionality — most core features of Pulsar are implemented as packages. In this section we will cover how to extend the functionality of Pulsar through writing packages. Packages can do a number of things: change the user interface, add a new theme, add a grammar for a language, and more. We'll learn this by writing a series of increasingly complex packages together, introducing you to new APIs, tools, and techniques as we need them. From 308028dd0e7a4b0df37368a49432c59c5dad2cf0 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:53:43 -0800 Subject: [PATCH 10/50] Update docs/docs/launch-manual-v2/sections/authoring-packages/index.md Co-authored-by: Andrew Dupont --- docs/docs/launch-manual-v2/sections/authoring-packages/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/index.md b/docs/docs/launch-manual-v2/sections/authoring-packages/index.md index fa2c928d2..977b71bbd 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/index.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/index.md @@ -8,7 +8,7 @@ A huge part of Pulsar is made up of bundled and community-made packages. If you In this section we will cover how to extend the functionality of Pulsar through writing packages. Packages can do a number of things: change the user interface, add a new theme, add a grammar for a language, and more. We'll learn this by writing a series of increasingly complex packages together, introducing you to new APIs, tools, and techniques as we need them. -Additionally we will then take a look at how we can get your packages published to the Pulsar Package Registry using the built in tool PPM to do so. +We'll then take a look at how we can get new packages published to the Pulsar Package Registry using the built-in tool `ppm`. --- From dece7733a9a524fc143af3757099d7a41427db16 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:53:57 -0800 Subject: [PATCH 11/50] Update docs/docs/launch-manual-v2/sections/authoring-packages/index.md Co-authored-by: Andrew Dupont --- docs/docs/launch-manual-v2/sections/authoring-packages/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/index.md b/docs/docs/launch-manual-v2/sections/authoring-packages/index.md index 977b71bbd..470b933be 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/index.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/index.md @@ -12,7 +12,7 @@ We'll then take a look at how we can get new packages published to the Pulsar Pa --- -If you are just jumping in here are some resources you may want to keep handy to get yourself familair with the other parts of Pulsar we will be using here. +If you are just jumping in, here are some resources you may want to keep handy to get yourself familiar with the other parts of Pulsar we'll be using. - [Pulsar Package Registry API]() - [Pulsar Editor API]() From 6a59cba6b16d76ff76087f8fe22480b1e9fd4b32 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:55:04 -0800 Subject: [PATCH 12/50] Update docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md Co-authored-by: Andrew Dupont --- .../authoring-packages/sections/publishing-a-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md index 00cc25d13..ef25b1d08 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md @@ -9,7 +9,7 @@ See more in the [PPM Docs]() section. There are a few important things to double check before publishing your package: - Your `package.json` file has a `name`, `description`, and `repository` fields. -- Your `package.json` `name` field is URL Safe, as in it doesn't include an emoji or special character. +- Your `package.json` `name` field is URL-safe — for instance, it doesn't include any emoji or other special characters. - Your `package.json` `version` field is [Semver V2](https://semver.org/spec/v2.0.0.html) compliant. - Your `package.json` `engines` field contains an entry for `atom` such as: `"enginges": { "atom": ">=1.0.0 <2.0.0"}`. - Your package has a `README.md` file at it's root. From b87a9d0ad711a8f628102f8fcee466fb5e8e7f2d Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:55:16 -0800 Subject: [PATCH 13/50] Update docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md Co-authored-by: Andrew Dupont --- .../authoring-packages/sections/publishing-a-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md index ef25b1d08..7fc6f81a6 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md @@ -11,7 +11,7 @@ There are a few important things to double check before publishing your package: - Your `package.json` file has a `name`, `description`, and `repository` fields. - Your `package.json` `name` field is URL-safe — for instance, it doesn't include any emoji or other special characters. - Your `package.json` `version` field is [Semver V2](https://semver.org/spec/v2.0.0.html) compliant. -- Your `package.json` `engines` field contains an entry for `atom` such as: `"enginges": { "atom": ">=1.0.0 <2.0.0"}`. +- Your `package.json` `engines` field contains an entry for `atom` such as: `"engines": { "atom": ">=1.0.0 <2.0.0"}`. - Your package has a `README.md` file at it's root. - Your `repository` URL in the `package.json` file is the same as the URL of your repository on GitHub. - Your package is in a git repository that has been pushed to [GitHub](https://github.com). Follow [this guide](https://help.github.com/articles/importing-a-git-repository-using-the-command-line/) if your package isn't already on GitHub. From d4699f9de37b8990e33c8ad571aaf2ca630227af Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:55:26 -0800 Subject: [PATCH 14/50] Update docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md Co-authored-by: Andrew Dupont --- .../authoring-packages/sections/publishing-a-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md index 7fc6f81a6..88dc5bda3 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md @@ -12,7 +12,7 @@ There are a few important things to double check before publishing your package: - Your `package.json` `name` field is URL-safe — for instance, it doesn't include any emoji or other special characters. - Your `package.json` `version` field is [Semver V2](https://semver.org/spec/v2.0.0.html) compliant. - Your `package.json` `engines` field contains an entry for `atom` such as: `"engines": { "atom": ">=1.0.0 <2.0.0"}`. -- Your package has a `README.md` file at it's root. +- Your package has a `README.md` file at its root. - Your `repository` URL in the `package.json` file is the same as the URL of your repository on GitHub. - Your package is in a git repository that has been pushed to [GitHub](https://github.com). Follow [this guide](https://help.github.com/articles/importing-a-git-repository-using-the-command-line/) if your package isn't already on GitHub. From b8bb67197aeb0b6b0b9f19023b842f3b1a0042f4 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:55:44 -0800 Subject: [PATCH 15/50] Update docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md Co-authored-by: Andrew Dupont --- .../authoring-packages/sections/publishing-a-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md index 88dc5bda3..0a6bfea60 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md @@ -18,7 +18,7 @@ There are a few important things to double check before publishing your package: ### Publishing Your Package -Before you publish a package it is a good idea to check ahead of time if a +Before you publish a package, it's a good idea to check ahead of time if a package with the same name has already been published to [the Pulsar Package Repository](https://web.pulsar-edit.dev/packages). You can do that by visiting `https://web.pulsar-edit.dev/packages/your-package-name` to From 0d212bcb6316322c52c24403220eedfc22f207c0 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:55:59 -0800 Subject: [PATCH 16/50] Update docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md Co-authored-by: Andrew Dupont --- .../authoring-packages/sections/publishing-a-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md index 0a6bfea60..6ac10eaed 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md @@ -21,7 +21,7 @@ There are a few important things to double check before publishing your package: Before you publish a package, it's a good idea to check ahead of time if a package with the same name has already been published to [the Pulsar Package Repository](https://web.pulsar-edit.dev/packages). You can -do that by visiting `https://web.pulsar-edit.dev/packages/your-package-name` to +do that by visiting `https://web.pulsar-edit.dev/packages/[your-package-name]` to see if the package already exists. If it does, update your package's name to something that is available before proceeding. From fbc0c69efcb8da49a7f0b3802ec4fa9824cead12 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:56:56 -0800 Subject: [PATCH 17/50] Update docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md Co-authored-by: Andrew Dupont --- .../authoring-packages/sections/publishing-a-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md index 6ac10eaed..6184b9b75 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md @@ -46,7 +46,7 @@ If this is the first package you are publishing, the `pulsar -p publish` command Additionally if this is your first time publishing to the Pulsar Package Registry, you also need to provide PPM an API token to access your Pulsar User Account. If you don't have a Pulsar User Account already, you'll need to make one on the [Pulsar Website](https://web.pulsar-edit.dev/login). You can learn more about creating an account on the [Pulsar Website Docs](). Once you have successfully created an account copy the API token available on your user page and use `pulsar -p --login ` to give PPM your API Key. Again just like your GitHub credentials this API Key is stored securely in your [keychain](). -Now your package is published and available on the Pulsar Package Registry. Head on over to `https://web.pulsar-edit.dev/packages/your-package-name` to see your package's page. +Now your package is published and available on the Pulsar Package Registry. Head on over to `https://web.pulsar-edit.dev/packages/[your-package-name]` to see your package's page. With `pulsar -p publish`, you can bump the version and publish by using From b8fcb8ea1b78bdb24e2d6c3c0797a1b2a45b64fe Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:57:09 -0800 Subject: [PATCH 18/50] Update docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md Co-authored-by: Andrew Dupont --- .../authoring-packages/sections/publishing-a-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md index 6184b9b75..01ca06ece 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md @@ -54,7 +54,7 @@ With `pulsar -p publish`, you can bump the version and publish by using $ pulsar -p publish ``` -Where `version-type` can be `major`, `minor`, and `patch`. +where `version-type` can be `major`, `minor`, and `patch`. - **MAJOR** version when you make incompatible API changes. - **MINOR** version when you add functionality in a backwards compatible manner. From 0e9af20f9c5fad066b23dbf295651cde846302ab Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:58:25 -0800 Subject: [PATCH 19/50] Update docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md Co-authored-by: Andrew Dupont --- .../authoring-packages/sections/publishing-a-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md index 01ca06ece..e4e8c6424 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md @@ -60,7 +60,7 @@ where `version-type` can be `major`, `minor`, and `patch`. - **MINOR** version when you add functionality in a backwards compatible manner. - **PATCH** version when you make backwards compatible bug fixes. -i.e. to bump a package from v1.**0**.0 to v1.**1**.0: +For instance, to bump a package from v1.**0**.0 to v1.**1**.0: ```sh $ pulsar -p publish minor From 947fae6ab3d4174dea11cbc9df9fd3fb46c94d03 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:58:33 -0800 Subject: [PATCH 20/50] Update docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md Co-authored-by: Andrew Dupont --- .../authoring-packages/sections/publishing-a-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md index e4e8c6424..1d83165d4 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md @@ -68,4 +68,4 @@ $ pulsar -p publish minor Check out [semantic versioning](https://semver.org/) to learn more about best practices for versioning your package releases. -You can also run `pulsar -p help publish` to see all the available options and `pulsar -p help` to see all the other available commands. Or check our the [PPM Docs]() to learn more about using PPM. +You can also run `pulsar -p help publish` to see all the available options and `pulsar -p help` to see all the other available commands. Or check our the [PPM Docs]() to learn more about using `ppm`. From 58ce937ea6cf6e6ebf9b0939cc027fd8f99fca2f Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 16:58:46 -0800 Subject: [PATCH 21/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/index.md Co-authored-by: Andrew Dupont --- docs/docs/launch-manual-v2/sections/ppr-frontend/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/index.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/index.md index 611e4b6ac..348dd5f5f 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/index.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/index.md @@ -4,7 +4,7 @@ title: Pulsar Package Registry Frontend Website description: Using and Navigating the Pulsar Package Registry Website --- -# Pulsar Package Registry Frontend Website +# Pulsar Package Registry The Package Registry Frontend Website viewable on [https://web.pulsar-edit.dev](https://web.pulsar-edit.dev/) is the frontend counterpart to the Pulsar Package Registry. Allowing an easy way for anyone on any platform to view and browse the packages that are available to install on Pulsar. From 35ad98294ad2c32b88b6f2abbd45c69106bb7734 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:00:44 -0800 Subject: [PATCH 22/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/index.md Co-authored-by: Andrew Dupont --- docs/docs/launch-manual-v2/sections/ppr-frontend/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/index.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/index.md index 348dd5f5f..e8d840111 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/index.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/index.md @@ -6,7 +6,7 @@ description: Using and Navigating the Pulsar Package Registry Website # Pulsar Package Registry -The Package Registry Frontend Website viewable on [https://web.pulsar-edit.dev](https://web.pulsar-edit.dev/) is the frontend counterpart to the Pulsar Package Registry. Allowing an easy way for anyone on any platform to view and browse the packages that are available to install on Pulsar. +The [Pulsar Package Registry](https://web.pulsar-edit.dev/) is an easy way for anyone on any platform to view and browse the packages that are available to install on Pulsar. While the website isn't much more than a wrapper around the actual Pulsar Package Registry API it does serve a few important purposes for Pulsar. From fd7758f3e12f976f6eadf03fd5a685c8c3d09443 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:00:51 -0800 Subject: [PATCH 23/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/index.md Co-authored-by: Andrew Dupont --- docs/docs/launch-manual-v2/sections/ppr-frontend/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/index.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/index.md index e8d840111..b77fbe08a 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/index.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/index.md @@ -8,7 +8,6 @@ description: Using and Navigating the Pulsar Package Registry Website The [Pulsar Package Registry](https://web.pulsar-edit.dev/) is an easy way for anyone on any platform to view and browse the packages that are available to install on Pulsar. -While the website isn't much more than a wrapper around the actual Pulsar Package Registry API it does serve a few important purposes for Pulsar. ::: details Sections From a5b7b640d11f307d364b799043f2a0e03a15cddc Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:01:18 -0800 Subject: [PATCH 24/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index 1f6f7caf4..f23ef708e 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -1,6 +1,6 @@ ## Pulsar User Account -A Pulsar User Account enables you to Publish and manage Published Packages to the Pulsar Package Registry, as well as lets you star packages that exist on the Pulsar Package Registry. +A Pulsar user account enables you to publish to the Pulsar Package Registry, manage packages you've published, and “star” your favorite packages. Otherwise for just downloading and using packages from the Pulsar Package Registry no account is required. From edce353657a19cbcb615d3f402690b4dad9ae25d Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:01:27 -0800 Subject: [PATCH 25/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index f23ef708e..b519f18a2 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -2,7 +2,7 @@ A Pulsar user account enables you to publish to the Pulsar Package Registry, manage packages you've published, and “star” your favorite packages. -Otherwise for just downloading and using packages from the Pulsar Package Registry no account is required. +If you don't plan on doing any of these things, you don't need to create a user account. ### Creating a Pulsar User Account From ba84d97474040b0416090e02dddd78cc30286342 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:01:41 -0800 Subject: [PATCH 26/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index b519f18a2..b2ab73625 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -6,7 +6,7 @@ If you don't plan on doing any of these things, you don't need to create a user ### Creating a Pulsar User Account -To create a Pulsar User Account you just need to navigate to the Pulsar Package Registry Website and click "Sign In" on the top header bar. +To create a Pulsar user account, navigate to the [Pulsar Package Registry](https://web.pulsar-edit.dev) and click "Sign In" on the top header bar — or go directly to [the signup page](https://web.pulsar-edit.dev/login). Otherwise you can go directly to [the Signup Page](https://web.pulsar-edit.dev/login). Here you can see there's a few choices of how to create your account. From f51d4bdccb1a6086e7a1e10081244a960d83b654 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:01:57 -0800 Subject: [PATCH 27/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index b2ab73625..efcebb89c 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -7,7 +7,6 @@ If you don't plan on doing any of these things, you don't need to create a user ### Creating a Pulsar User Account To create a Pulsar user account, navigate to the [Pulsar Package Registry](https://web.pulsar-edit.dev) and click "Sign In" on the top header bar — or go directly to [the signup page](https://web.pulsar-edit.dev/login). -Otherwise you can go directly to [the Signup Page](https://web.pulsar-edit.dev/login). Here you can see there's a few choices of how to create your account. From 913b4acd8f6ec3065b02ff3b44996b3220d3df13 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:02:10 -0800 Subject: [PATCH 28/50] Update docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md Co-authored-by: Andrew Dupont --- .../authoring-packages/sections/publishing-a-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md index 1d83165d4..2eb691a39 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md @@ -42,7 +42,7 @@ $ cd path-to-your-package $ pulsar -p publish minor ``` -If this is the first package you are publishing, the `pulsar -p publish` command may prompt you for your GitHub username and password. If you have two-factor authentication enabled, use a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) in lieu of a password. This is required for PPM to automatically manage and push tags to your package's GitHub repo and is needed only during the first time publishing. The credentials are stored securely in your [keychain]() once you login. +If this is the first package you are publishing, the `pulsar -p publish` command may prompt you for your GitHub username and password. If you have two-factor authentication enabled, use a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) in lieu of a password. This is required for `ppm` to automatically manage and push tags to your package's GitHub repo and is needed only during the first time publishing. The credentials are stored securely in your [keychain]() once you login. Additionally if this is your first time publishing to the Pulsar Package Registry, you also need to provide PPM an API token to access your Pulsar User Account. If you don't have a Pulsar User Account already, you'll need to make one on the [Pulsar Website](https://web.pulsar-edit.dev/login). You can learn more about creating an account on the [Pulsar Website Docs](). Once you have successfully created an account copy the API token available on your user page and use `pulsar -p --login ` to give PPM your API Key. Again just like your GitHub credentials this API Key is stored securely in your [keychain](). From 0f4803b262aba7e1d6dda74f1585eba80d8886c3 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:02:44 -0800 Subject: [PATCH 29/50] Update docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md --- .../authoring-packages/sections/publishing-a-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md index 2eb691a39..add0a502b 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md @@ -8,7 +8,7 @@ See more in the [PPM Docs]() section. There are a few important things to double check before publishing your package: -- Your `package.json` file has a `name`, `description`, and `repository` fields. +- Your `package.json` file has the `name`, `description`, and `repository` fields. - Your `package.json` `name` field is URL-safe — for instance, it doesn't include any emoji or other special characters. - Your `package.json` `version` field is [Semver V2](https://semver.org/spec/v2.0.0.html) compliant. - Your `package.json` `engines` field contains an entry for `atom` such as: `"engines": { "atom": ">=1.0.0 <2.0.0"}`. From 8ed0b64cf87e77487eecee330f562d71953fa43c Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:03:07 -0800 Subject: [PATCH 30/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index efcebb89c..a01a0981c 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -8,7 +8,7 @@ If you don't plan on doing any of these things, you don't need to create a user To create a Pulsar user account, navigate to the [Pulsar Package Registry](https://web.pulsar-edit.dev) and click "Sign In" on the top header bar — or go directly to [the signup page](https://web.pulsar-edit.dev/login). -Here you can see there's a few choices of how to create your account. +There are two ways to create an account: - [Sign Up with a PAT Token](#sign-up-with-a-pat-token) - [Sign Up with GitHub OAuth](#sign-up-with-github-oauth) From d7eb53e4273d5ae4a589dcccba3bdb5db3c9ea4f Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:03:49 -0800 Subject: [PATCH 31/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index a01a0981c..63eeb6d10 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -17,7 +17,7 @@ There are two ways to create an account: Using a PAT token from GitHub allows you precise control over what permissions your Pulsar User Account has over your GitHub account, which you don't get with the OAuth Signup. -This way you can go to your GitHub Account and [create your own PAT token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) that is create a Personal Access Token with only the permissions you decide. +You can go to your GitHub Account and [create your own PAT token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token), granting only the permissions that Pulsar needs. When creating your PAT token it's good to know what scopes should be allowed access to your Pulsar User Account. By default the only scopes needed are: From c304afae300c1e5d07539add3010f5a567f50d29 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:04:03 -0800 Subject: [PATCH 32/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index 63eeb6d10..4aa813a55 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -19,7 +19,7 @@ Using a PAT token from GitHub allows you precise control over what permissions y You can go to your GitHub Account and [create your own PAT token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token), granting only the permissions that Pulsar needs. -When creating your PAT token it's good to know what scopes should be allowed access to your Pulsar User Account. By default the only scopes needed are: +Pulsar needs **only** the permissions listed below: - public_repo - read:org From 47633931bd315eec8ef68980c19bfe64d2f1ea18 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:04:14 -0800 Subject: [PATCH 33/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index 4aa813a55..97e524166 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -24,7 +24,6 @@ Pulsar needs **only** the permissions listed below: - public_repo - read:org -Beyond that your Pulsar User Account won't try to use any additional permissions. Once your PAT Token is created navigate back to the Pulsar Signup Screen and plug your PAT token into the text box where it says "Enter your GitHub PAT" and click "Sign Up". After a few redirects you should be brought to your [Pulsar User Account Page](https://web.pulsar-edit.dev/users). From 1a733ed2cb50d43d514f5a67270a600f013e447b Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:04:51 -0800 Subject: [PATCH 34/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index 97e524166..f994f29e4 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -25,7 +25,7 @@ Pulsar needs **only** the permissions listed below: - read:org -Once your PAT Token is created navigate back to the Pulsar Signup Screen and plug your PAT token into the text box where it says "Enter your GitHub PAT" and click "Sign Up". After a few redirects you should be brought to your [Pulsar User Account Page](https://web.pulsar-edit.dev/users). +Once your PAT Token is created, navigate back to the Pulsar signup page. Paste your PAT token into the "Enter your GitHub PAT" text box and click "Sign Up." After a few redirects, you should be brought to your [Pulsar user account page](https://web.pulsar-edit.dev/users). #### Sign Up with GitHub OAuth From 1f1eb16d4350f7977f6e25ca03b481936b73b234 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:05:32 -0800 Subject: [PATCH 35/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index f994f29e4..456565049 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -31,7 +31,9 @@ Once your PAT Token is created, navigate back to the Pulsar signup page. Paste y Using GitHub OAuth signup means you don't have to manage the permissions and signup process on your own as opposed to the PAT Token signup. -Still when signing up with GitHub OAuth the only permissions requested (That you'll be able to review during the process) are: +When you click "Sign Up with GitHub OAuth," you'll be redirected to GitHub to authorize Pulsar to access your account. On that page, you can double-check that you're connecting Pulsar to the correct account and review the permissions being granted. + +You'll be able to confirm that the **only** permissions requested by Pulsar are the following: - public_repo - read:org From ece7baf4d8971f157c5de0dfca71316f62a11af9 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:05:39 -0800 Subject: [PATCH 36/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index 456565049..fa3b8e266 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -38,7 +38,6 @@ You'll be able to confirm that the **only** permissions requested by Pulsar are - public_repo - read:org -These are the only permissions needed for your Pulsar User Account to access all features it's capable of. Once you click to "Sign Up with GitHub OAuth" you'll be redirected to GitHub to authorize Pulsar to access your account. There you can check the account you are allowing access, and review the permissions being granted. From 155630730d477e23b149cf98a03ffd18d9fe6604 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:05:52 -0800 Subject: [PATCH 37/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index fa3b8e266..18a8d4cbb 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -39,7 +39,6 @@ You'll be able to confirm that the **only** permissions requested by Pulsar are - read:org -Once you click to "Sign Up with GitHub OAuth" you'll be redirected to GitHub to authorize Pulsar to access your account. There you can check the account you are allowing access, and review the permissions being granted. Afterwards you should be redirected to your [Pulsar User Account Page](https://web.pulsar-edit.dev/users). From 96a558e82de18483026d1a7dc8f655a2748234ea Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:06:02 -0800 Subject: [PATCH 38/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index 18a8d4cbb..ad6a23821 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -40,7 +40,7 @@ You'll be able to confirm that the **only** permissions requested by Pulsar are -Afterwards you should be redirected to your [Pulsar User Account Page](https://web.pulsar-edit.dev/users). +Afterwards you should be redirected to your [Pulsar user account page](https://web.pulsar-edit.dev/users). #### Managing your Account From 2fd2e265de4644319db75c05558e08044cdcf9b2 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:06:11 -0800 Subject: [PATCH 39/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index ad6a23821..da6604091 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -44,7 +44,7 @@ Afterwards you should be redirected to your [Pulsar user account page](https://w #### Managing your Account -Now that your Pulsar User Account has been successfully created you can manage it on your [Pulsar User Account Page](https://web.pulsar-edit.dev/users). +Now that your Pulsar user account has been successfully created, you can manage it on your [Pulsar user account page](https://web.pulsar-edit.dev/users). Here you can view the account information saved to Pulsar, and view your Pulsar API Token. From 34ec523bf711d8f3c420352d7c66bdc47e1cd254 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:06:20 -0800 Subject: [PATCH 40/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index da6604091..c5ea44194 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -46,7 +46,7 @@ Afterwards you should be redirected to your [Pulsar user account page](https://w Now that your Pulsar user account has been successfully created, you can manage it on your [Pulsar user account page](https://web.pulsar-edit.dev/users). -Here you can view the account information saved to Pulsar, and view your Pulsar API Token. +On this page, you can view the account information saved to Pulsar and your Pulsar API token. This token is what enables you to publish to the Pulsar Package Registry using `ppm`. This Pulsar API Token is what can be used to allow you to publish to the Pulsar Package Registry using [PPM](). From 18730d41db3b779dbf96a0b728a3eef4c2a6e7a9 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:06:27 -0800 Subject: [PATCH 41/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index c5ea44194..32ec8f2e9 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -48,7 +48,6 @@ Now that your Pulsar user account has been successfully created, you can manage On this page, you can view the account information saved to Pulsar and your Pulsar API token. This token is what enables you to publish to the Pulsar Package Registry using `ppm`. -This Pulsar API Token is what can be used to allow you to publish to the Pulsar Package Registry using [PPM](). Otherwise if you ever notice your account information here has become out of date (i.e. you've changed your profile picture) you can always click "Log Out" at the top of the page, and sign in again with the same steps as before. When you click go through the sign up process after already having created a Pulsar User Account this just updates your account information with what's most recent from GitHub. From 4d67fcb81a5acfbb19a2088e5c3f162b59fde789 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:06:57 -0800 Subject: [PATCH 42/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index 32ec8f2e9..d784ce147 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -49,7 +49,7 @@ Now that your Pulsar user account has been successfully created, you can manage On this page, you can view the account information saved to Pulsar and your Pulsar API token. This token is what enables you to publish to the Pulsar Package Registry using `ppm`. -Otherwise if you ever notice your account information here has become out of date (i.e. you've changed your profile picture) you can always click "Log Out" at the top of the page, and sign in again with the same steps as before. When you click go through the sign up process after already having created a Pulsar User Account this just updates your account information with what's most recent from GitHub. +If you need to refresh your account information — for instance, if you've changed your profile picture — you can click "Log Out" at the top of the page and sign in again using the same process described above. This does not affect any of the packages you've already published. #### Notes on a Pulsar User Account From ee57d917ff2a5786308951005e508bab802a9732 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:07:08 -0800 Subject: [PATCH 43/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index d784ce147..1ab261cfa 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -51,7 +51,7 @@ On this page, you can view the account information saved to Pulsar and your Puls If you need to refresh your account information — for instance, if you've changed your profile picture — you can click "Log Out" at the top of the page and sign in again using the same process described above. This does not affect any of the packages you've already published. -#### Notes on a Pulsar User Account +#### Privacy A few important notes about your Pulsar User Account to keep in mind. From 62d4bb79b2552f3a30cb455c5f72f6f22f66b366 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:07:14 -0800 Subject: [PATCH 44/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index 1ab261cfa..837f8dbb7 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -53,7 +53,6 @@ If you need to refresh your account information — for instance, if you've chan #### Privacy -A few important notes about your Pulsar User Account to keep in mind. Pulsar greatly respects your privacy, and more than that doesn't want the chance to invade your privacy, or be responsible for your sensitive account credentials. From e4889b16965763bf5baa3212da9a86ebaa3cbb5b Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:07:31 -0800 Subject: [PATCH 45/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index 837f8dbb7..4d7b9087d 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -54,7 +54,7 @@ If you need to refresh your account information — for instance, if you've chan #### Privacy -Pulsar greatly respects your privacy, and more than that doesn't want the chance to invade your privacy, or be responsible for your sensitive account credentials. +Pulsar respects your privacy. We don't want to feel intrusive, and we especially don't want the responsibility of managing your sensitive information. That's why when you create a User Account with Pulsar there are only three pieces of information stored about you: From 24b85cd95ce6f342ae3b92cd370806e96a5c1401 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:07:40 -0800 Subject: [PATCH 46/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index 4d7b9087d..d85f9f781 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -56,7 +56,7 @@ If you need to refresh your account information — for instance, if you've chan Pulsar respects your privacy. We don't want to feel intrusive, and we especially don't want the responsibility of managing your sensitive information. -That's why when you create a User Account with Pulsar there are only three pieces of information stored about you: +That's why we store only three pieces of information about you when you create a Pulsar user account: - Your GitHub Account Username. - Your GitHub Gravatar Image URL. From 2f3ff4832e3d8b50930b47d08fc6799272ed5d1c Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:08:06 -0800 Subject: [PATCH 47/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index d85f9f781..61aa461be 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -62,6 +62,8 @@ That's why we store only three pieces of information about you when you create a - Your GitHub Gravatar Image URL. - Your GitHub `node_id`. -Think of your `node_id` like the random number GitHub assigned to your account when you created it. This is a public value that anyone on GitHub can find using the API and doesn't reveal any private details about yourself , your location or your account. Beyond this the Pulsar Backend collects zero information about who you are, and doesn't even save your API Keys itself. +Think of your `node_id` as a random number GitHub assigned to your account when you created it. This is a public value that anyone on GitHub can find using the API. It doesn't reveal any private details about yourself, your location, or your account. + +Beyond these three values, Pulsar collects and stores nothing about who you are. Pulsar doesn't even store your API key. If you'd like to read more about how your information is used for Pulsar take a look at our [Privacy Policy]() or the [Pulsar Backend]() Documentation. From f258bd58b1511be248b80460a25b0e600e24382b Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:08:27 -0800 Subject: [PATCH 48/50] Update docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md Co-authored-by: Andrew Dupont --- .../sections/ppr-frontend/sections/pulsar-user-account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md index 61aa461be..84b45c0a8 100644 --- a/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md +++ b/docs/docs/launch-manual-v2/sections/ppr-frontend/sections/pulsar-user-account.md @@ -66,4 +66,4 @@ Think of your `node_id` as a random number GitHub assigned to your account when Beyond these three values, Pulsar collects and stores nothing about who you are. Pulsar doesn't even store your API key. -If you'd like to read more about how your information is used for Pulsar take a look at our [Privacy Policy]() or the [Pulsar Backend]() Documentation. +If you want to know more about how your information is used, please read our [privacy policy]() or the [Pulsar backend]() documentation. From 8026838eddd23ca98331ec313ecc3162b1552275 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:08:45 -0800 Subject: [PATCH 49/50] Update docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md Co-authored-by: Andrew Dupont --- .../authoring-packages/sections/publishing-a-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md index add0a502b..bf4841c4d 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md @@ -44,7 +44,7 @@ $ pulsar -p publish minor If this is the first package you are publishing, the `pulsar -p publish` command may prompt you for your GitHub username and password. If you have two-factor authentication enabled, use a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) in lieu of a password. This is required for `ppm` to automatically manage and push tags to your package's GitHub repo and is needed only during the first time publishing. The credentials are stored securely in your [keychain]() once you login. -Additionally if this is your first time publishing to the Pulsar Package Registry, you also need to provide PPM an API token to access your Pulsar User Account. If you don't have a Pulsar User Account already, you'll need to make one on the [Pulsar Website](https://web.pulsar-edit.dev/login). You can learn more about creating an account on the [Pulsar Website Docs](). Once you have successfully created an account copy the API token available on your user page and use `pulsar -p --login ` to give PPM your API Key. Again just like your GitHub credentials this API Key is stored securely in your [keychain](). +Additionally if this is your first time publishing to the Pulsar Package Registry, you also need to provide`ppm` an API token to access your Pulsar User Account. If you don't have a Pulsar User Account already, you'll need to make one on the [Pulsar Website](https://web.pulsar-edit.dev/login). You can learn more about creating an account on the [Pulsar Website Docs](). Once you have successfully created an account copy the API token available on your user page and use `pulsar -p --login ` to give `ppm` your API key. This API key, like your GitHub credentials, is stored securely in your [keychain](). Now your package is published and available on the Pulsar Package Registry. Head on over to `https://web.pulsar-edit.dev/packages/[your-package-name]` to see your package's page. From 4ea85abb3c146a3531cccb651c1842ac1d6a0295 Mon Sep 17 00:00:00 2001 From: confused_techie Date: Tue, 21 Feb 2023 17:10:09 -0800 Subject: [PATCH 50/50] Update docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md --- .../authoring-packages/sections/publishing-a-package.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md index bf4841c4d..a8de141bc 100644 --- a/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md +++ b/docs/docs/launch-manual-v2/sections/authoring-packages/sections/publishing-a-package.md @@ -44,7 +44,7 @@ $ pulsar -p publish minor If this is the first package you are publishing, the `pulsar -p publish` command may prompt you for your GitHub username and password. If you have two-factor authentication enabled, use a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) in lieu of a password. This is required for `ppm` to automatically manage and push tags to your package's GitHub repo and is needed only during the first time publishing. The credentials are stored securely in your [keychain]() once you login. -Additionally if this is your first time publishing to the Pulsar Package Registry, you also need to provide`ppm` an API token to access your Pulsar User Account. If you don't have a Pulsar User Account already, you'll need to make one on the [Pulsar Website](https://web.pulsar-edit.dev/login). You can learn more about creating an account on the [Pulsar Website Docs](). Once you have successfully created an account copy the API token available on your user page and use `pulsar -p --login ` to give `ppm` your API key. This API key, like your GitHub credentials, is stored securely in your [keychain](). +Additionally if this is your first time publishing to the Pulsar Package Registry, you also need to provide `ppm` an API token to access your Pulsar User Account. If you don't have a Pulsar User Account already, you'll need to make one on the [Pulsar Website](https://web.pulsar-edit.dev/login). You can learn more about creating an account on the [Pulsar Website Docs](). Once you have successfully created an account copy the API token available on your user page and use `pulsar -p --login ` to give `ppm` your API key. This API key, like your GitHub credentials, is stored securely in your [keychain](). Now your package is published and available on the Pulsar Package Registry. Head on over to `https://web.pulsar-edit.dev/packages/[your-package-name]` to see your package's page.