Skip to content

Commit ec1b31c

Browse files
committed
fix md formatting
1 parent 85cf3cc commit ec1b31c

File tree

1 file changed

+20
-16
lines changed

1 file changed

+20
-16
lines changed

DEVELOPMENT.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Version Support Guidelines
1+
# Development
2+
3+
## Version Support Guidelines
24

35
Elixir itself supports 5 versions with security updates:
46
https://hexdocs.pm/elixir/compatibility-and-deprecations.html#content
@@ -8,30 +10,32 @@ http://erlang.2086793.n4.nabble.com/OTP-Versions-and-Maint-Branches-td4722416.ht
810

911
ElixirLS generally aims to support the last 3 versions of Elixir and the last 3 versions of OTP. However this is not a hard and fast rule and may change in the future.
1012

11-
# Packaging
13+
## Packaging
14+
15+
Follow those instuctions when publishing a new release.
1216

13-
Bump the changelog
14-
Bump the version numbers in `apps/elixir_ls_debugger/mix.exs`, `apps/elixir_ls_utils/mix.exs`, and `apps/language_server/mix.exs`
15-
Make PR
16-
Merge PR
17-
Pull down the latest master
18-
Make the tag from the new master
19-
Push the tag (`git push upstream --tags`)
20-
Wait for github actions to push up a draft release https://github.com/elixir-lsp/elixir-ls/releases
21-
Edit the draft release with a link to the changelog
22-
Publish the draft release
17+
1. Bump the changelog
18+
2. Bump the version numbers in `apps/elixir_ls_debugger/mix.exs`, `apps/elixir_ls_utils/mix.exs`, and `apps/language_server/mix.exs`
19+
3. Make PR
20+
4. Merge PR
21+
5. Pull down the latest master
22+
6. Make the tag from the new master
23+
7. Push the tag (`git push upstream --tags`)
24+
8. Wait for github actions to push up a draft release https://github.com/elixir-lsp/elixir-ls/releases
25+
9. Edit the draft release with a link to the changelog
26+
10. Publish the draft release
2327

24-
# Debugging
28+
## Debugging
2529

2630
If you're debugging a running server than `IO.inspect` is a good approach, any messages you create with it will be sent to your LSP client as a log message
2731

2832
To debug in tests you can use `IO.inspect(Process.whereis(:user), message, label: "message")` to send your output directly to the group leader of the test process.
2933

30-
# Documentation website
34+
## Documentation website
3135

3236
The documentation website is built using the [Mkdocs](https://www.mkdocs.org) static website generator. The content is written in Markdown format in the directory [docs](./docs) and is configured via the [mkdocs.yml](./mkdocs.yml) file.
3337

34-
## Development
38+
### Development
3539

3640
Make sure you have a recent version of Python 3 and [Pip](https://pip.readthedocs.io/en/stable/installing/) installed.
3741

@@ -43,6 +47,6 @@ pip install mkdocs mkdocs-material
4347

4448
Once installed, simply run `mkdocs serve` from the project root. This will start a local web server with a file watcher.
4549

46-
## Build
50+
### Build
4751

4852
To compile the website for deployment, run `mkdocs build` from the project root. The built static assets will be located in the `site` directory. These can then be served by any web hosting solution.

0 commit comments

Comments
 (0)