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

Launch Manual V2 Skeleton #172

Open
wants to merge 50 commits into
base: main
Choose a base branch
from
Open

Launch Manual V2 Skeleton #172

wants to merge 50 commits into from

Conversation

confused-Techie
Copy link
Member

While this PR is nowhere near completing the docs, it does have complete sections giving a general layout of the new documentation format.

Essentially here I've followed the ideas from our Discussions and started laying out the docs like I suggested there, additionally I've added some sections for some of the tooling on Pulsar.

The way I envision this be further layed out would be the largest section of Launch Manual then having many subsections. Which in this PR includes

  • Pulsar Package Registry Frontend Website
  • Authoring Packages

Then each section is able to go into as much detail as needed for that topic. But allows users to easily find what they need to know. The first section here is just about the website itself, and I'd like to see us do this for more of our big ticket items that we use, such as one for PPM, one for Pulsar that could contain just the generic usage of the editor, we could even include ones for some of our bigger or more complicated packages, teletype, and so on.

In this section these would all be user facing documents, not getting into the programming details but just general usage details.

Additionally though we are discussing on Discord how we could include more documentation from specific repos onto the site for developers.

But this is just a start to make sure we like the new layout and see what we can do.

Also to note, this PR purposefully doesn't link to this section of the docs anywhere, as they are so far from complete it'd just be confusing to users to list it publicly at this point. Although this PR would still allow you to navigate by URL to the docs.

Copy link
Contributor

@savetheclocktower savetheclocktower left a comment

Choose a reason for hiding this comment

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

Sorry, I know this is a nitpicky review, but my journalism degree needed exercising.

My main goals were:

  • Fix typos.
  • Make explanations less conversational and more terse.
  • Only use title case in phrases if they describe something with a special meaning, like “Pulsar Package Registry.” Other usages (e.g., “Pulsar User Account”) can be lowercased when they refer to something with a commonly understood meaning.
  • When a sentence starts with a subordinate clause, you'll usually want to separate it from the main clause with a comma. The previous sentence illustrates this.

Copy link
Contributor

@icecream17 icecream17 left a comment

Choose a reason for hiding this comment

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

a few more notes (edit: can't really resolve so hid)


## [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.

This comment was marked as resolved.


There are a few important things to double check before publishing your package:

- Your `package.json` file has a `name`, `description`, and `repository` fields.

This comment was marked as resolved.


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.
Copy link
Contributor

Choose a reason for hiding this comment

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

tbh idk what exactly the update is. patch, minor, or major, or is this about the database somehow?

Edit: Oh this is answered below. This isn't really a review since it comes before the information. Maybe replace with a summary, or move after the info?


- **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.
Copy link
Contributor

Choose a reason for hiding this comment

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

reminds me of this one rust comment. maybe this formulation is simpler:

major - upgrading breaks
minor - downgrading breaks
patch - neither

Copy link
Member Author

Choose a reason for hiding this comment

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

While that might be a bit simpler, the text taken here iirc is taken directly from the SEMVER docs, and is what we currently use.

But as we do already link to the semver docs maybe we can take the opportunity to make this a bit simpler?

Copy link
Contributor

@icecream17 icecream17 Feb 22, 2023

Choose a reason for hiding this comment

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

this formulation isn't exactly the same as semver but it does make things clearer I think...

confused-Techie and others added 23 commits February 21, 2023 16:51
…s/publishing-a-package.md

Co-authored-by: Andrew Dupont <[email protected]>
…s/publishing-a-package.md

Co-authored-by: Andrew Dupont <[email protected]>
…s/publishing-a-package.md

Co-authored-by: Andrew Dupont <[email protected]>
…s/publishing-a-package.md

Co-authored-by: Andrew Dupont <[email protected]>
…s/publishing-a-package.md

Co-authored-by: Andrew Dupont <[email protected]>
…s/publishing-a-package.md

Co-authored-by: Andrew Dupont <[email protected]>
…s/publishing-a-package.md

Co-authored-by: Andrew Dupont <[email protected]>
…s/publishing-a-package.md

Co-authored-by: Andrew Dupont <[email protected]>
…s/publishing-a-package.md

Co-authored-by: Andrew Dupont <[email protected]>
confused-Techie and others added 21 commits February 21, 2023 17:02
…s/publishing-a-package.md

Co-authored-by: Andrew Dupont <[email protected]>
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.

3 participants