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

Add in all wiki articles from now defunct atom #8

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/infrastructure/infrastructure.11tydata.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@
{
"text": "Interacting with other packages via services",
"link": "/infrastructure/interacting-with-other-packages-via-services"
},
{
"text": "Integrate with Autocomplete Plus",
"link": "/infrastructure/integrate-with-autocomplete-plus"
}
]

Expand Down
439 changes: 439 additions & 0 deletions docs/infrastructure/integrate-with-autocomplete-plus.md

Large diffs are not rendered by default.

59 changes: 59 additions & 0 deletions docs/maintaining-pulsar/atom-languageclient-package-wiki.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: Atom-LanguageClient Package Wiki
layout: doc.ejs
---

The following wiki article is a small piece of Pulsar/Atom's history.
It may also prove to be useful when dealing with this particular package in the future.
This wiki entry was taken directly from the [`atom/atom-languagelcient` package wiki](https://github.com/atom/atom-languageclient/wiki) and is mirrored here in case that ever becomes inaccessible.

::: warning Warning

The contents of this article do not in any way represent actions, thoughts, or ideas expressed by the Pulsar team.
Full credit for the content of the below page belongs to [@Damien Guard](https://github.com/damieng) and [@David Wilson](https://github.com/daviwil).

:::

## List of Atom packages using `atom-languageclient`

Here are the known Atom packages that are using atom-languageclient today;

### Official Packages

- [C#](https://github.com/pulsar-edit/ide-csharp) based on Omnisharp.
- [Flow](https://github.com/flowtype/ide-flowtype) from Facebook.
- [Java](https://github.com/pulsar-edit/ide-java) based on Eclipse JDT.
- [JSON](https://github.com/pulsar-edit/ide-json) based on VSCode JSON language server.
- [TypeScript](https://github.com/pulsar-edit/ide-typescript) based on TypeScript server.

### Community Packages

- [Bash](https://github.com/mads-hartmann/ide-bash) provides Bash language support using [Bash Language Server](https://github.com/mads-hartmann/bash-language-server).
- [Docker](https://web.pulsar-edit.dev/packages/ide-docker) provides Dockerfile language support using the [Dockerfile Language Server](https://github.com/rcjsuen/dockerfile-language-server-nodejs).
- [Fortran](https://web.pulsar-edit.dev/packages/ide-fortran) provides Fortran language support using the [hansec's Fortran Language Server](https://github.com/hansec/fortran-language-server).
- [Haskell-hie](https://github.com/Tehnix/ide-haskell-hie) provides Haskell support via the [Haskell IDE Engine](https://github.com/haskell/haskell-ide-engine).
- [PHP](https://github.com/atom/ide-php) based on FelixFBecker's Language Server.
- [PowerShell](https://github.com/daviwil/ide-powershell) provides PowerShell language support using [PowerShell Editor Services](https://github.com/PowerShell/PowerShellEditorServices).
- [Python](https://github.com/lgeiger/ide-python) provides Python support via [Python Language Server](https://github.com/palantir/python-language-server).
- [Reason](https://github.com/zaaack/atom-ide-reason) provides OCaml and Reason support using [OCaml Language Server](https://github.com/freebroccolo/ocaml-language-server).
- [Rust](https://github.com/mehcode/atom-ide-rust) provides Rust support using [Rust Language Server](https://github.com/rust-lang-nursery/rls).
- [Scala](https://github.com/laughedelic/atom-ide-scala) provides Scala language support using [Metals](https://github.com/scalameta/metals) and [Dotty Language Server](http://dotty.epfl.ch/docs/usage/ide-support.html).
- [Vue](https://github.com/rwatts3/atom-ide-vue) provides Vue language support using the [Vue Language Server](https://www.npmjs.com/package/vue-language-server).

## Release Process

### Steps

1. Pull down the latest changes from `master`.
2. Edit [CHANGELOG.md](https://github.com/pulsar-edit/atom-languageclient/blob/master/CHANGELOG.md) to add relevant release notes for changes wince the previous release with a corresponding `## N.N.N` section header.
3. Add and commit CHANGELOG.md with message "Updated CHANGELOG for [version in format N.N.N]".
4. Run `npm run test` and verify that no tests failed.
5. Run `npm run flow` and verify that there are no errors.
6. Run `npm version [version type]` where the version type is `major`, `minor`, or `path` depending on the [semantic versioning](https://semver.org/) impact of the changes.
7. Run `git log -1` and make sure a commit was made for the new version (double-check version in package.json if you like).
8. If all looks good, run `npm publish` to publish the package.
9. Run `git push --tags` to push the new version tag to GitHub.
10. Go to the atom-languageclient [tags page](https://github.com/pulsar-edit/atom-languageclient/tags) and click "Add Release Notes" for the tag corresponding to the release you just published.
11. Paste the contents of your new CHANGELOG.md section, sans version header, into the "Describe this release" box.
12. Click the "Publish release" button.
13. 🎉
64 changes: 64 additions & 0 deletions docs/maintaining-pulsar/github-package-wiki.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: GitHub Package Wiki
layout: doc.ejs
---

The following wiki article is a small piece of Pulsar/Atom's history.
This wiki entry was taken directly from the [`atom/github` package wiki](https://github.com/atom/github/wiki) and is mirrored here in case that ever becomes inaccessible.

::: warning Warning

The contents of this article do not in any way represent actions, thoughts or ideas expressed by the Pulsar team.
Full credit for the content of the below page belongs to [@Katrina Uychaco](https://github.com/kuychaco) and [@Michelle Tilley](https://github.com/BinaryMuse).

:::

## Roadmaps

[Short Term Roadmap](https://github.com/atom/github/projects/8)

## Monthly Planning

### June 2017

## Looking Back

- Beta launch went very well
- Relatively few problems
- Performance work [@smashwilson](https://github.com/smashwilson) and [@kuychaco](https://github.com/kuychaco) did is ✨
- GPG/credential helper work that [@smashwilson](https://github.com/smashwilson) shipped was solid
- Feeling good about shipping to stable

## This Month

- Ensure room to triage and fix issues that may arise after shipping to stable
- File change notification service [@smashwilson](https://github.com/smashwilson)
- GitHub integration [@BinaryMuse](https://github.com/BinaryMuse) [@kuychaco](https://github.com/kuychaco)
- Create new PR
- Fill out existing functionality (timeline item types, new fields, etc.)
- Add mechanism for manual/auto refreshing
- Continue to investigate possibility of real-time updates
- Git integration [@kuychaco](https://github.com/kuychaco)
- Add "last commit(s)" view under commit box
- Investigate removing amend checkbox in favor of more robust HEAD management

## Other Topics Discussed

- Web Workers
- Wait to see if issues arise with current implementation
- Better remote/branch management
- Existing UI mocks are relatively old and pre-docks
- Want to ensure what we ship is close to what we'll want long term to ensure UI/UX stability over time
- Resume conversation around design and pick this up in coming months
- `core:undo` support
- Undo support is a misnomer in a system where there's not a linear set of edits
- Want to design a system where any action is recoverable (different from undoable)
- Really talking about UI Git porcelain at this point
- Start deeper conversations now, talk about more at mini-summit
- Git log / graph
- We could do something simple now very quickly but would it be up to the standards we want?
- Decided to work on "last commit(s)" view for June, talk about this more at mini-summit
- Stash support
- Start talking about UI/UX
- Additional GitHub PR work
- "Checking out" a PR from the GH pane is a great first step toward implementing a full code review flow
23 changes: 23 additions & 0 deletions docs/maintaining-pulsar/ide-java-package-wiki.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: IDE-Java Package Wiki
layout: doc.ejs
---

The following wiki article is a small piece of Pulsar/Atom's history.
It may also prove to be useful when dealing with this particulr package in the future.
This wiki entry was taken directly from the [`atom/ide-java` package wiki](https://github.com/atom/ide-java/wiki) and is mirrored here in case that ever becomes inaccessible.

::: warning Warning

The contents of this article do not in any way represent actions, thoughts, or ideas expressed by the Pulsar team.
Full credit for the content of the below page belongs to [@Damien Guard](https://github.com/damieng).

:::

## Incomplete Classpath Warning

In order to properly analyze Java files a project definition must be found that indicates the packages, paths to search for classes etc.

You should open the folder that contains the pom.xml or build.gradle file if you want full diagnostics, errors, auto-completion etc.

If you don't need the full analysis you can ignore this warning and work with a subset of the available features.
12 changes: 12 additions & 0 deletions docs/maintaining-pulsar/maintaining-pulsar.11tydata.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@
{
"text": "Tooling",
"link": "/maintaining-pulsar/tooling"
},
{
"text": "GitHub Package Wiki",
"link": "/maintaining-pulsar/github-package-wiki"
},
{
"text": "Atom-LanguageClient Package Wiki",
"link": "/maintaining-pulsar/atom-languageclient-package-wiki"
},
{
"text": "IDE-Java Package Wiki",
"link": "/maintaining-pulsar/ide-java-package-wiki"
}
]
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/wiki/autocomplete-plus/scopename.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.