Summary

Document using TypeScript and ES6 modules for extensions.

Review Request #12955 — Created April 14, 2023 and submitted April 20, 2023, 8:03 a.m.

Information

Owner

david

Repository

Review Board

Branch

release-6.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This change updates the extension static media documentation to explain

what is needed to enable the use of TypeScript and ES6 modules (as well

as ES6 more generally) in extensions.
The only part that's still missing is an explanation of how to import

code from the Review Board/Djblets JavaScript codebase. I'm undecided if

that's something we should document now (and perhaps enable via some

symlinks like .reviewboard/.djblets during the setup.py develop

process), or if we should wait until more of those codebases have been

converted to modules.

Testing Done

Built HTML and checked output.

Commits

Summary	ID
Document using TypeScript and ES6 modules for extensions. This change updates the extension static media documentation to explain what is needed to enable the use of TypeScript and ES6 modules (as well as ES6 more generally) in extensions. The only part that's still missing is an explanation of how to import code from the Review Board/Djblets JavaScript codebase. I'm undecided if that's something we should document now (and perhaps enable via some symlinks like `.reviewboard`/`.djblets` during the `setup.py develop` process), or if we should wait until more of those codebases have been converted to modules. Testing Done: Built HTML and checked output.	317a127264ad4346902ae3f7e27072ee3ea97f3e

Summary

Document using TypeScript and ES6 modules for extensions.

This change updates the extension static media documentation to explain what is needed to enable the use of TypeScript and ES6 modules (as well as ES6 more generally) in extensions. The only part that's still missing is an explanation of how to import code from the Review Board/Djblets JavaScript codebase. I'm undecided if that's something we should document now (and perhaps enable via some symlinks like `.reviewboard`/`.djblets` during the `setup.py develop` process), or if we should wait until more of those codebases have been converted to modules. Testing Done: Built HTML and checked output.

317a127264ad4346902ae3f7e27072ee3ea97f3e

Issues

Description	From	Last Updated
Can you add reference IDs for these sections, so we can more easily link to them later?	chipx86	April 18, 2023, 1:59 p.m.
We should aim for shorter paragraphs. Any new piece of information should be a paragraph. This will help with SEO …	chipx86	April 18, 2023, 3:37 p.m.
The respective orderings here are wrong.	chipx86	April 18, 2023, 1:58 p.m.
Missing trailing period.	chipx86	April 18, 2023, 1:58 p.m.
Two blank lines before reference definitions.	chipx86	April 18, 2023, 1:58 p.m.
Similarly, "This can be customized ..." would be a good point to split the paragraph into a new one.	chipx86	April 18, 2023, 1:58 p.m.
"With the rollup.config.js example above..." would be a good new paragraph.	chipx86	April 18, 2023, 1:59 p.m.

flake8 passed.

JSHint passed.

docs/manual/extending/extensions/static-files.rst (Diff revision 1)

Show all issues

Can you add reference IDs for these sections, so we can more easily link to them later?

docs/manual/extending/extensions/static-files.rst (Diff revision 1)

Show all issues

We should aim for shorter paragraphs. Any new piece of information should be a paragraph. This will help with SEO in general (if it's easier to skim, it's better).

Let's take that last sentence, make it its own paragraph, and use it to prefix a bullet point list of some modern features. We can link to ES6 Modules, list ES6 classes, and maybe link to Spina.

docs/manual/extending/extensions/static-files.rst (Diff revision 1)
Show all issues
```
The respective orderings here are wrong.
```
docs/manual/extending/extensions/static-files.rst (Diff revision 1)
Show all issues
```
Missing trailing period.
```
docs/manual/extending/extensions/static-files.rst (Diff revision 1)
Show all issues
```
Two blank lines before reference definitions.
```

docs/manual/extending/extensions/static-files.rst (Diff revision 1)

Show all issues

Similarly, "This can be customized ..." would be a good point to split the paragraph into a new one.

docs/manual/extending/extensions/static-files.rst (Diff revision 1)

Show all issues

"With the rollup.config.js example above..." would be a good new paragraph.

Commits:

	Summary	ID
	Document using TypeScript and ES6 modules for extensions. This change updates the extension static media documentation to explain what is needed to enable the use of TypeScript and ES6 modules (as well as ES6 more generally) in extensions. The only part that's still missing is an explanation of how to import code from the Review Board/Djblets JavaScript codebase. I'm undecided if that's something we should document now (and perhaps enable via some symlinks like `.reviewboard`/`.djblets` during the `setup.py develop` process), or if we should wait until more of those codebases have been converted to modules. Testing Done: Built HTML and checked output.	68226b8628cc62d4453bd56f101125285938736c
	Document using TypeScript and ES6 modules for extensions. This change updates the extension static media documentation to explain what is needed to enable the use of TypeScript and ES6 modules (as well as ES6 more generally) in extensions. The only part that's still missing is an explanation of how to import code from the Review Board/Djblets JavaScript codebase. I'm undecided if that's something we should document now (and perhaps enable via some symlinks like `.reviewboard`/`.djblets` during the `setup.py develop` process), or if we should wait until more of those codebases have been converted to modules. Testing Done: Built HTML and checked output.	317a127264ad4346902ae3f7e27072ee3ea97f3e

Diff:

Revision 2 (+258 -10)

Show changes

	docs/manual/conf.py
	docs/manual/extending/extensions/static-files.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-6.x (f96369d)