Skip to content

Commit

Permalink
Docs: Create a "Community" menu and add "Support & Chat" link
Browse files Browse the repository at this point in the history
* Rename the About menu to "Community".
* Move "Browser Support" to Guides.
* Write "Support" and "Chat" sections.
* Add "Support & Chat" link to the Community menu.
* Enable Bluesky link in theme footer.

Also sort out the mess that's become of the app.element.io client
which for unknown reasons no longer allows guest viewing, it just
throws up a login wall instead. As workaround, use the app.gitter.im
link, which hosts the same Element Web client, but does still permit
guest viewing.

The reason to keep both is that the gitter.im client is configured
to only allow login via GitHub or GitLab account. This domain is
not registered as universal link for Element native apps, and also
offers no (easy) way to create (or login with) a Matrix.org account.
  • Loading branch information
Krinkle committed Jan 19, 2025
1 parent 088069b commit d484d14
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 10 deletions.
3 changes: 2 additions & 1 deletion build/hydra-config.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
{
"//": [
"twitter.com serves broken redirect-loop",
"app.element.io chat rooms render fine but use HTTP 404 for some reason",
"element.io and gitter.im chat rooms render fine but oddly use HTTP 404",
"npmjs.com responds HTTP 429 Too Many Requests too easily",
"Skip trivial github.com links to hopefully avoid HTTP 429 Too Many Requests",
""
],
"exclude_scheme_prefixes": [
"https://twitter.com/",
"https://app.element.io/",
"https://app.gitter.im/",
"https://www.npmjs.com/package/",
"https://github.com/qunitjs/qunit/issues/",
"https://github.com/qunitjs/qunit/pull/",
Expand Down
2 changes: 1 addition & 1 deletion docs/Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ source "https://rubygems.org"
ruby RUBY_VERSION

# To apply changes, run `bundle update`.
gem "jekyll-theme-amethyst", "2.5.0", group: :jekyll_plugins
gem "jekyll-theme-amethyst", "2.6.1", group: :jekyll_plugins
3 changes: 2 additions & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,10 @@ amethyst:
release_base: https://github.com/qunitjs/qunit/releases/tag/
author_permalink: /blog/author/:author/
mastodon: https://fosstodon.org/@qunit
bluesky: https://bsky.app/profile/qunitjs.com
twitter: qunitjs
github: qunitjs
chat: https://app.element.io/#/room/#qunitjs_qunit:gitter.im
chat: /intro/#support
# https://github.com/qunitjs/jekyll-theme-amethyst/blob/main/docs/getting-started.md#enable-typesense
typesense:
origin: https://typesense.jquery.com
Expand Down
8 changes: 5 additions & 3 deletions docs/_data/sitenav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
href: /intro/
- name: Browser Runner
href: /browser/
- name: Browser Support
href: /browser/#browser-support
- name: Command-line Interface
href: /cli/
- name: Download
Expand All @@ -17,13 +19,13 @@
href: /api/
- name: Blog
href: /blog/
- name: About
- name: Community
href: /about/
sub:
- name: Support & Chat
href: /intro/#support
- name: Who's using QUnit?
href: /projects/
- name: Browser Support
href: /browser/#browser-support
- name: About QUnit
href: /about/
- name: Badge
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ These are the official [release channels](intro.md#download) for QUnit:

## Join the Community

<p class="lead lead--center" markdown="1">Join us on [Mastodon](https://fosstodon.org/@qunit), [Twitter](https://twitter.com/qunitjs), or [Matrix chat](https://app.element.io/#/room/#qunitjs_qunit:gitter.im).</p>
<p class="lead lead--center" markdown="1">Join us on [Mastodon](https://fosstodon.org/@qunit), [Bluesky](https://bsky.app/profile/qunitjs.com), or [Matrix chat](./intro.md#support).</p>

To contribute:

Expand Down
23 changes: 21 additions & 2 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,28 @@ Check these QUnit tutorials and examples, to make the most of your unit tests!

## Support

To report a bug or request a new feature, [open an issue](https://github.com/qunitjs/qunit/issues).
To report a bug, request a new feature, or ask a question [open an issue](https://github.com/qunitjs/qunit/issues) on GitHub.

If you need help using QUnit, join us in the [Matrix chat](https://app.element.io/#/room/#qunitjs_qunit:gitter.im)!
You can also find support on StackOverflow. Use the ["qunit" hashtag on StackOverflow](https://stackoverflow.com/questions/tagged/qunit) to search existing questions or ask your own question.

## Chat

If you need help, join us in our chat room on Matrix at `#qunitjs_qunit:gitter.im`:

* **[Gitter web client](https://app.gitter.im/#/room/#qunitjs_qunit:gitter.im)**, browse the room as guest.
* [Element web client](https://app.element.io/#/room/#qunitjs_qunit:gitter.im), join and log in (with GitHub, GitLab, Google, or Apple ID), or sign up.
* [matrix.to link](https://matrix.to/#/#qunitjs_qunit:gitter.im?web-instance[element.io]=app.gitter.im), join with the Element native app or other Matrix client.

## Social media

Follow us:
* [Mastodon: @qunit@fosstodon.org](https://fosstodon.org/@qunit)
* [Bluesky: @qunitjs.com](https://bsky.app/profile/qunitjs.com)

Hashtags:
* [Mastodon: #qunit](https://mastodon.social/tags/qunit)
* [Bluesky: #qunit](https://bsky.app/hashtag/qunit)
* [Threads: #qunit](https://www.threads.net/search?q=%23qunit&serp_type=default)

---

Expand Down
2 changes: 1 addition & 1 deletion docs/upgrade-guide-2.x.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ QUnit.assert.mod2 = function (value, expected, message) {

### Removed `QUnit.init` without replacement

This method used to reinitialize the test runner. It should never have been exposed as a public method and is now gone, without replacement. If you've built an integration or runner framework that requires the use of `QUnit.init`, reach out in our [Chat room](https://app.element.io/#/room/#qunitjs_qunit:gitter.im), or contact us in the [issue tracker](https://github.com/qunitjs/qunit/issues) to help find a replacement.
This method used to reinitialize the test runner. It should never have been exposed as a public method and is now gone, without replacement. If you've built an integration or runner framework that requires the use of `QUnit.init`, reach out in our [Chat room](./intro.md#chat), or contact us in the [issue tracker](https://github.com/qunitjs/qunit/issues) to help find a replacement.

### Removed `QUnit.reset`

Expand Down

0 comments on commit d484d14

Please sign in to comment.