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

Rebranding #6739

Merged
merged 14 commits into from
Jan 17, 2023
Merged
Show file tree
Hide file tree
Changes from 4 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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ assignees: ''
- Operating System and version: e.g. Windows 10
- Version of WebKnossos (Release or Commit):
- [ ] Specific to long-running jobs (set `jobsEnabled=true` in `application.conf`)
- [ ] Specific to webKnossos.org (set `isDemoInstance=true` in `application.conf`)
- [ ] Specific to webknossos.org (set `isDemoInstance=true` in `application.conf`)
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ assignees: ''
## Context
<!--- Why is this change / new feature important ? What are its use cases? -->
* [ ] Specific to long-running jobs (set `jobsEnabled=true` in `application.conf`)
* [ ] Specific to webKnossos.org (set `isDemoInstance=true` in `application.conf`)
* [ ] Specific to webknossos.org (set `isDemoInstance=true` in `application.conf`)
22 changes: 11 additions & 11 deletions Contributing Guide.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Contributing Guide

**Welcome to the webKnossos contributing guide :sparkles: **
**Welcome to the WEBKNOSSOS contributing guide :sparkles: **

Thank you for taking the time to contribute to this project! The following is a set of guidelines for contributing to webKnossos. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
Thank you for taking the time to contribute to this project! The following is a set of guidelines for contributing to WEBKNOSSOS. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

## Code of Conduct

webKnossos and everyone contributing and collaborating on this project is expected to follow the [webKnossos Code of Conduct](CODE_OF_CONDUCT.md). Please report unacceptable behavior to [[email protected]](mailto:[email protected]).
WEBKNOSSOS and everyone contributing and collaborating on this project is expected to follow the [WEBKNOSSOS Code of Conduct](CODE_OF_CONDUCT.md). Please report unacceptable behavior to [[email protected]](mailto:[email protected]).


## How can I help?
Expand All @@ -20,20 +20,20 @@ We welcome community feedback and contributions! We are happy to have

## Feedback, Observations and Questions

We'd love to hear your feedback on the webKnossos!
We'd love to hear your feedback on the WEBKNOSSOS!
We're also interested in hearing if this tool don't work for your usecase,
or if you have questions regarding its usage.

Please leave a message on the [image.sc forum](https://forum.image.sc/tag/webknossos)
using the `webknossos` tag to enable public communication on those topics.
If you prefer to share information only with the webKnossos team, please write an email
If you prefer to share information only with the WEBKNOSSOS team, please write an email
to [[email protected]](mailto:[email protected]). For commercial support please
reach out to [scalable minds](https://scalableminds.com).


## Issues: Feature Suggestions and Bug Reports

We track feature requests and bug reports in the [webKnossos repository issues](https://github.com/scalableminds/webknossos/issues).
We track feature requests and bug reports in the [WEBKNOSSOS repository issues](https://github.com/scalableminds/webknossos/issues).
Before opening a new issue, please do a quick search of existing issues to make sure your suggestion hasn’t already been added.
If your issue doesn’t already exist, and you’re ready to create a new one, make sure to state what you would like to implement, improve or bugfix.
Please use one of the provided templates to make this process easier for you.
Expand All @@ -54,8 +54,8 @@ that you use the API as intended. If that's the case, please

If you are missing a feature to support your use-case, please consider the following points:

1. Please verify if this feature is directly related to webKnossos.
Does it belong into the webKnossos?
1. Please verify if this feature is directly related to WEBKNOSSOS.
Does it belong into the WEBKNOSSOS?
2. Double-check if an issue for this feature exists already. If there is one with a very similar scope,
please considering commenting there.
3. If possible, consider how the implementation might look like (e.g. how would the public API change),
Expand Down Expand Up @@ -88,7 +88,7 @@ Please include the following in your pull request:
* Adapt or add the documentation.
* Consider enhancing the examples.

The specific coding styles, test frameworks and documentation setup of webKnossos are described
The specific coding styles, test frameworks and documentation setup of WEBKNOSSOS are described
in the following sections:


Expand All @@ -109,6 +109,6 @@ The [webknossos repository](https://github.com/scalableminds/webknossos) is stru

### Documentation

We render a combined documentation for webKnossos itself and the webKnossos Python libraries from the webknossos-libs repository using [mkdocs](https://www.mkdocs.org/). Source-files for the documentation are stored in the `docs` directory.
We render a combined documentation for WEBKNOSSOS itself and the WEBKNOSSOS Python libraries from the webknossos-libs repository using [mkdocs](https://www.mkdocs.org/). Source-files for the documentation are stored in the `docs` directory.

The documentation is deploy automatically through GitHub actions from the [webKnossos Python libraries repository](https://github.com/scalableminds/webknossos-libs/actions).
The documentation is deploy automatically through GitHub actions from the [WEBKNOSSOS Python libraries repository](https://github.com/scalableminds/webknossos-libs/actions).
14 changes: 7 additions & 7 deletions DEV_INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ docker-compose pull webknossos
./start-docker.sh
```

Open your local webKnossos instance on [localhost:9000](http://localhost:9000) and complete the onboarding steps in the browser.
Now, you are ready to use your local webKnossos instance.
Open your local WEBKNOSSOS instance on [localhost:9000](http://localhost:9000) and complete the onboarding steps in the browser.
Now, you are ready to use your local WEBKNOSSOS instance.

See the wiki for [instructions on updating](https://github.com/scalableminds/webknossos/wiki/Development-setup) this development setup.

Expand All @@ -29,7 +29,7 @@ For non-localhost deployments, check out the [installation guide in the document

### MacOS
```bash
# webKnossos needs to be run from x86_64 environment (only applicable for arm64-based Macs)
# WEBKNOSSOS needs to be run from x86_64 environment (only applicable for arm64-based Macs)
arch -x86_64 /bin/zsh

# Install Homebrew package manager
Expand Down Expand Up @@ -58,13 +58,13 @@ psql -c "CREATE USER postgres WITH ENCRYPTED PASSWORD 'postgres';"
psql -c "ALTER USER postgres WITH SUPERUSER;"
psql -c "GRANT ALL PRIVILEGES ON DATABASE webknossos TO postgres;"

# Checkout the webKnossos git repository
# Checkout the WEBKNOSSOS git repository
git clone [email protected]:scalableminds/webknossos.git


```

Note: On arm64-based Macs (e.g. M1), you need to run webKnossos in an x86_64 environment (Rosetta 2). In case you accidentally started webKnossos in an arm64 environment, it is advisable to delete several caches `~/.m2`, `~/ivy2`, `~/.sbt`, `~/.yarn-cache` and run `./clean`. Since Postgres and Redis are isolated processes, they can be run either from arm64 or x86_64 environments.
Note: On arm64-based Macs (e.g. M1), you need to run WEBKNOSSOS in an x86_64 environment (Rosetta 2). In case you accidentally started WEBKNOSSOS in an arm64 environment, it is advisable to delete several caches `~/.m2`, `~/ivy2`, `~/.sbt`, `~/.yarn-cache` and run `./clean`. Since Postgres and Redis are isolated processes, they can be run either from arm64 or x86_64 environments.


### Ubuntu 20.04 LTS
Expand Down Expand Up @@ -121,9 +121,9 @@ First, install all frontend dependencies via
```bash
yarn install
```
Note: During this installation step, it might happen that the module `gl` cannot be installed correctly. As this module is only used for testing webKnossos, you can safely ignore this error.
Note: During this installation step, it might happen that the module `gl` cannot be installed correctly. As this module is only used for testing WEBKNOSSOS, you can safely ignore this error.

To start webKnossos, use
To start WEBKNOSSOS, use
```bash
yarn start
```
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# [webKnossos](https://webknossos.org/)
<img align="right" src="https://static.webknossos.org/images/oxalis.svg" alt="webKnossos Logo" />
webKnossos is an open-source tool for annotating and exploring large 3D image datasets.
# [WEBKNOSSOS](https://webknossos.org/)
<img align="right" src="https://static.webknossos.org/images/icon-only.svg" alt="WEBKNOSSOS Logo" />
WEBKNOSSOS is an open-source tool for annotating and exploring large 3D image datasets.

* Fly through your data for fast skeletonization and proof-reading
* Create 3D training data for automated segmentations efficiently
* Scale data reconstruction projects with crowdsourcing workflows
* Share datasets and annotations with collaborating scientists

[Start using webKnossos](https://webknossos.org) - [On your own server](https://docs.webknossos.org/webknossos/installation.html) - [User Documentation](https://docs.webknossos.org) - [Contact us](mailto:[email protected])
[Start using WEBKNOSSOS](https://webknossos.org) - [On your own server](https://docs.webknossos.org/webknossos/installation.html) - [User Documentation](https://docs.webknossos.org) - [Contact us](mailto:[email protected])

[![](https://img.shields.io/circleci/project/github/scalableminds/webknossos/master.svg?logo=circleci)](https://circleci.com/gh/scalableminds/webknossos)
[![](https://img.shields.io/github/release/scalableminds/webknossos.svg)](https://github.com/scalableminds/webknossos/releases/latest)
Expand Down Expand Up @@ -44,9 +44,9 @@ webKnossos is an open-source tool for annotating and exploring large 3D image da
[Read more about the original publication.](https://publication.webknossos.org)

## Installation
webKnossos is open-source, so you can install it on your own server.
WEBKNOSSOS is open-source, so you can install it on your own server.

[Check out the documentation](https://docs.webknossos.org/webknossos/installation.html) for a tutorial on how to install webKnossos on your own server.
[Check out the documentation](https://docs.webknossos.org/webknossos/installation.html) for a tutorial on how to install WEBKNOSSOS on your own server.

For development installations, please see `DEV_INSTALL.md` file.

Expand All @@ -61,17 +61,17 @@ For details on community contributions, please refer to our [Contributing guide]

Contact us at [[email protected]](mailto:[email protected]).

[scalable minds](https://scalableminds.com) offers commercial hosting, support and development services for webKnossos.
[scalable minds](https://scalableminds.com) offers commercial hosting, support and development services for WEBKNOSSOS.


## Credits
* scalable minds - https://scalableminds.com/
* Max Planck Institute for Brain Research – https://brain.mpg.de/

webKnossos was inspired by [KNOSSOS](https://knossos.app).
WEBKNOSSOS was inspired by [KNOSSOS](https://knossos.app).

### Thanks
* [Browser Stack](https://www.browserstack.com/) for letting us test webKnossos on a variety of different devices
* [Browser Stack](https://www.browserstack.com/) for letting us test WEBKNOSSOS on a variety of different devices
<a href="https://www.browserstack.com/"><img src="https://avatars.githubusercontent.com/u/1119453?s=200&v=4" width=100 alt="Browserstack Logo" align="right"></a>
* [CircleCI](https://circleci.com/gh/scalableminds/webknossos) for letting us run builds and tests on their CI

Expand Down
4 changes: 2 additions & 2 deletions app/controllers/Application.scala
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ class Application @Inject()(multiUserDAO: MultiUserDAO,
private lazy val Mailer =
actorSystem.actorSelection("/user/mailActor")

@ApiOperation(value = "Information about the version of webKnossos")
@ApiOperation(value = "Information about the version of WEBKNOSSOS")
@ApiResponses(
Array(
new ApiResponse(code = 200, message = "JSON object containing information about the version of webKnossos"),
new ApiResponse(code = 200, message = "JSON object containing information about the version of WEBKNOSSOS"),
new ApiResponse(code = 400, message = "Operation could not be performed. See JSON body for more information.")
))
def buildInfo: Action[AnyContent] = sil.UserAwareAction.async {
Expand Down
4 changes: 2 additions & 2 deletions app/controllers/InitialDataController.scala
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Samplecountry
ObjectId.generate,
"sample_organization",
additionalInformation,
"/assets/images/oxalis.svg",
"/assets/images/icon-only.svg",
"Sample Organization",
PricingPlan.Custom,
None,
Expand Down Expand Up @@ -132,7 +132,7 @@ Samplecountry
private val defaultPublication = Publication(
ObjectId("5c766bec6c01006c018c7459"),
Some(Instant.now),
Some("https://static.webknossos.org/images/oxalis.svg"),
Some("https://static.webknossos.org/images/icon-only.svg"),
Some("Dummy Title that is usually very long and contains highly scientific terms"),
Some(
"This is a wonderful dummy publication, it has authors, it has a link, it has a doi number, those could go here.\nLorem [ipsum](https://github.com/scalableminds/webknossos) dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.")
Expand Down
4 changes: 2 additions & 2 deletions app/controllers/OrganizationController.scala
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ class OrganizationController @Inject()(organizationDAO: OrganizationDAO,
defaultMails.upgradePricingPlanRequestMail(request.identity,
userEmail,
organization.displayName,
"Extend webKnossos plan by a year"))
"Extend WEBKNOSSOS plan by a year"))
} yield Ok
}

Expand All @@ -187,7 +187,7 @@ class OrganizationController @Inject()(organizationDAO: OrganizationDAO,
defaultMails.upgradePricingPlanRequestMail(request.identity,
userEmail,
organization.displayName,
s"Upgrade webKnossos Plan to $requestedPlan"))
s"Upgrade WEBKNOSSOS Plan to $requestedPlan"))
} yield Ok
}

Expand Down
28 changes: 14 additions & 14 deletions app/oxalis/mail/DefaultMails.scala
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class DefaultMails @Inject()(conf: WkConf) {
Mail(
from = defaultSender,
subject =
s"webKnossos | A new user ($name, $email) registered on $uri for ${organization.displayName} (${organization.name})",
s"WEBKNOSSOS | A new user ($name, $email) registered on $uri for ${organization.displayName} (${organization.name})",
bodyHtml = html.mail.notifyAdminNewUser(name, brainDBResult, uri, autoActivate).body,
recipients = List(organization.newUserMailingList)
)
Expand All @@ -37,7 +37,7 @@ class DefaultMails @Inject()(conf: WkConf) {
organization: Organization): Mail =
Mail(
from = defaultSender,
subject = s"webKnossos | Time limit reached. ${user.abreviatedName} in $projectName",
subject = s"WEBKNOSSOS | Time limit reached. ${user.abreviatedName} in $projectName",
bodyHtml = html.mail.notifyAdminTimeLimit(user.name, projectName, taskId, annotationId, uri).body,
recipients = List(organization.overTimeMailingList)
)
Expand All @@ -46,35 +46,35 @@ class DefaultMails @Inject()(conf: WkConf) {
implicit messages: Messages): Mail =
Mail(
from = defaultSender,
subject = "Welcome to webKnossos",
subject = "Welcome to WEBKNOSSOS",
bodyHtml = html.mail.newUser(name, brainDBresult.map(Messages(_)), enableAutoVerify).body,
recipients = List(receiver)
)

def activatedMail(name: String, receiver: String): Mail =
Mail(from = defaultSender,
subject = "webKnossos | Account activated",
subject = "WEBKNOSSOS | Account activated",
bodyHtml = html.mail.validateUser(name, uri).body,
recipients = List(receiver))

def changePasswordMail(name: String, receiver: String): Mail =
Mail(from = defaultSender,
subject = "webKnossos | Password changed",
subject = "WEBKNOSSOS | Password changed",
bodyHtml = html.mail.passwordChanged(name, uri).body,
recipients = List(receiver))

def resetPasswordMail(name: String, receiver: String, token: String): Mail =
Mail(
from = defaultSender,
subject = "webKnossos | Password Reset",
subject = "WEBKNOSSOS | Password Reset",
bodyHtml = html.mail.resetPassword(name, uri, token).body,
recipients = List(receiver)
)

def newOrganizationMail(organizationDisplayName: String, creatorEmail: String, domain: String): Mail =
Mail(
from = defaultSender,
subject = s"webKnossos | New Organization created on $domain",
subject = s"WEBKNOSSOS | New Organization created on $domain",
bodyHtml = html.mail.notifyAdminNewOrganization(organizationDisplayName, creatorEmail, domain).body,
recipients = List(newOrganizationMailingList)
)
Expand All @@ -87,7 +87,7 @@ class DefaultMails @Inject()(conf: WkConf) {
val host = Try { new URL(uri) }.toOption.getOrElse(uri)
Mail(
from = defaultSender,
subject = s"$senderName invited you to join their webKnossos organization at $host",
subject = s"$senderName invited you to join their WEBKNOSSOS organization at $host",
bodyHtml = html.mail.invite(senderName, organizationDisplayName, inviteTokenValue, uri, autoVerify).body,
recipients = List(receiver)
)
Expand All @@ -104,39 +104,39 @@ class DefaultMails @Inject()(conf: WkConf) {
def extendPricingPlanMail(user: User, userEmail: String): Mail =
Mail(
from = defaultSender,
subject = "webKnossos Plan Extension Request",
subject = "WEBKNOSSOS Plan Extension Request",
bodyHtml = html.mail.extendPricingPlan(user.name).body,
recipients = List(userEmail)
)

def upgradePricingPlanToTeamMail(user: User, userEmail: String): Mail =
Mail(
from = defaultSender,
subject = "webKnossos Plan Upgrade Request",
subject = "WEBKNOSSOS Plan Upgrade Request",
bodyHtml = html.mail.upgradePricingPlanToTeam(user.name).body,
recipients = List(userEmail)
)

def upgradePricingPlanToPowerMail(user: User, userEmail: String): Mail =
Mail(
from = defaultSender,
subject = "webKnossos Plan Upgrade Request",
subject = "WEBKNOSSOS Plan Upgrade Request",
bodyHtml = html.mail.upgradePricingPlanToPower(user.name).body,
recipients = List(userEmail)
)

def upgradePricingPlanUsersMail(user: User, userEmail: String, requestedUsers: Int): Mail =
Mail(
from = defaultSender,
subject = "Request to upgrade webKnossos users",
subject = "Request to upgrade WEBKNOSSOS users",
bodyHtml = html.mail.upgradePricingPlanUsers(user.name, requestedUsers).body,
recipients = List(userEmail)
)

def upgradePricingPlanStorageMail(user: User, userEmail: String, requestedStorage: Int): Mail =
Mail(
from = defaultSender,
subject = "Request to upgrade webKnossos storage",
subject = "Request to upgrade WEBKNOSSOS storage",
bodyHtml = html.mail.upgradePricingPlanStorage(user.name, requestedStorage).body,
recipients = List(userEmail)
)
Expand All @@ -147,7 +147,7 @@ class DefaultMails @Inject()(conf: WkConf) {
messageBody: String): Mail =
Mail(
from = defaultSender,
subject = "Request to upgrade webKnossos plan",
subject = "Request to upgrade WEBKNOSSOS plan",
bodyHtml = html.mail.upgradePricingPlanRequest(user.name, organizationDisplayName, messageBody).body,
recipients = List("[email protected]")
)
Expand Down
Loading