Skip to content
Merged
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ body:
- type: checkboxes
attributes:
label: Duplicates
description: Please [search the history](https://github.com/craftercms/craftercms/issues) to see if an issue exists for the same problem.
description: Please [search the history](https://github.com/craftersoftware/craftercms/issues) to see if an issue exists for the same problem.
options:
- label: I have searched the existing issues
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/enhancement_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ body:
- type: checkboxes
attributes:
label: Duplicates
description: Please [search the history](https://github.com/craftercms/craftercms/issues) to see if an issue already exists for the same enhancement request.
description: Please [search the history](https://github.com/craftersoftware/craftercms/issues) to see if an issue already exists for the same enhancement request.
options:
- label: I have searched the existing issues
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ body:
- type: checkboxes
attributes:
label: Duplicates
description: Please [search the history](https://github.com/craftercms/craftercms/issues) to see if an issue already exists for the same feature request.
description: Please [search the history](https://github.com/craftersoftware/craftercms/issues) to see if an issue already exists for the same feature request.
options:
- label: I have searched the existing issues
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/quality_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ body:
- type: checkboxes
attributes:
label: Duplicates
description: Please [search the history](https://github.com/craftercms/craftercms/issues) to see if an issue already exists for the same enhancement request.
description: Please [search the history](https://github.com/craftersoftware/craftercms/issues) to see if an issue already exists for the same enhancement request.
options:
- label: I have searched the existing issues
required: true
Expand Down
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Download a pre-built binary archive here: https://craftercms.com/download.

Read the docs here: https://craftercms.com/docs/

This repository is for developers interested in contributing to CrafterCMS, customizing their own release, or building the latest. This parent project helps you build the following:
This repository is for developers interested in contributing to CrafterCMS, customizing their own release, or building the latest. It contains all CrafterCMS modules and helps you build the following:

1. Deployable CrafterCMS binaries
2. Docker images
Expand All @@ -33,21 +33,21 @@ https://craftercms.com/docs/current/by-role/system-admin/installation.html#requi

Let's begin :)

If you're building deployable CrafterCMS binaries, we'll clone the tag where the tag is the release you want to build. For example, if we want to build CrafterCMS version 4.4.4, we'll check the [CrafterCMS tags list](https://github.com/craftercms/craftercms/tags) to get the tag for the version we want, which is `v4.4.4` for our example:
If you're building deployable CrafterCMS binaries, we'll clone the tag where the tag is the release you want to build. For example, if we want to build CrafterCMS version 4.4.4, we'll check the [CrafterCMS tags list](https://github.com/craftersoftware/craftercms/tags) to get the tag for the version we want, which is `v4.4.4` for our example:

```bash
git clone --branch v4.4.4 https://github.com/craftercms/craftercms.git
git clone --branch v4.4.4 https://github.com/craftersoftware/craftercms.git
```

OR

If you would like to contribute to CrafterCMS, to build a developer's environment, we'll need to clone the develop branch (default):

```bash
git clone https://github.com/craftercms/craftercms.git
git clone https://github.com/craftersoftware/craftercms.git
```

For more information on CrafterCMS Git Workflow, please review [CrafterCMS Git Workflow](https://github.com/craftercms/craftercms/blob/develop/GIT_WORKFLOW.md).
For more information on CrafterCMS Git Workflow, please review [CrafterCMS Git Workflow](https://github.com/craftersoftware/craftercms/blob/develop/GIT_WORKFLOW.md).

# 2. Summary of Commands and Options

Expand All @@ -58,7 +58,7 @@ For more information on CrafterCMS Git Workflow, please review [CrafterCMS Git W
* `clean` Clean modules
* `build` Build modules
* `deploy` Deploy modules
* `upgrade` Upgrade modules (same as `selfUpdate`, `clean`, `build`, `deploy`)
* `upgrade` Upgrade modules (same as `selfUpdate`, `clean`, `build`, `deploy`)
* `start` Start CrafterCMS
* `stop` Stop CrafterCMS
* `status` Report status on running environments if any
Expand Down Expand Up @@ -94,7 +94,7 @@ For more information on CrafterCMS Git Workflow, please review [CrafterCMS Git W
* `pushDockerImages`: Push the Docker images to DockerHub (if you have the right permissions), default `false`
* `tagDockerImages`: Tag the Docker images with the tag provided (if you have the right permissions), default is not to tag
* `rootlessDockerImages`: Docker images without using root at runtime, default `false`
* `dockerTag`: Tag used to build a Docker image, typically the version number, e.g. `4.2.0`
* `dockerTag`: Tag used to build a Docker image, typically the version number, e.g. `5.0.0`
* `dockerAuthoringBundle`: Use to point to an external authoring bundle from which to build the Docker images. This can be a remote URL, a local `.tar.gz` file path, or an expanded bundle path.
* `dockerDeliveryBundle`: Use to point to an external delivery bundle from which to build the Docker images. This can be a remote URL, a local `.tar.gz` file path, or an expanded bundle path.

Expand Down Expand Up @@ -133,7 +133,7 @@ To download, build and generate a binary archive from a given tag or branch of t
1. Clone the branch/tag of craftercms that you want to work with

```bash
git clone -b <tag or branch> https://github.com/craftercms/craftercms/
git clone -b <tag or branch> https://github.com/craftersoftware/craftercms.git
```

2. Download, build and bundle the tag/branch that you want to work with
Expand Down Expand Up @@ -211,25 +211,25 @@ To build, start and stop one of the two environments is similar to building/star

The mechanics for working with a single module are similar to working with _all_, with one exception: You can deploy a module to one or both environments (`authoring`/`delivery`).

CrafterCMS comprises the following modules:
CrafterCMS comprises the following modules (among others):

* [`engine`](https://craftercms.com/docs/current/reference/modules/engine/index.html)
* [`studio`](https://craftercms.com/docs/current/reference/modules/studio/index.html)
* [`profile`](https://craftercms.com/docs/current/reference/modules/profile/index.html)
* [`social`](https://craftercms.com/docs/current/reference/modules/social/index.html)
* [`deployer`](https://craftercms.com/docs/current/reference/modules/deployer/index.html)
* [`engine`](https://craftercms.com/docs/current/reference/modules/engine.html)
* [`studio`](https://craftercms.com/docs/current/reference/modules/studio.html)
* [`profile`](https://craftercms.com/docs/current/reference/modules/profile.html)
* [`social`](https://craftercms.com/docs/current/reference/modules/social.html)
* [`deployer`](https://craftercms.com/docs/current/reference/modules/deployer.html)

You'll find these projects under the root project directory and ready for you to contribute to in the folder `{Project Root}/{module}`.

### 4.3.1. Forking a Module
### 4.3.1. Forking the Repository

Start by forking the module you want to work on. You can follow the [GitHub instructions](https://help.github.com/articles/fork-a-repo/).
The next step is to switch the origin url location to be the one just forked, to do so you can use [these GitHub instructions](https://help.github.com/articles/changing-a-remote-s-url/).
The last step will be to add an upstream repository from the main `craftercms` repo to your own. Follow [these steps](https://help.github.com/articles/fork-a-repo/#step-3-configure-git-to-sync-your-fork-with-the-original-spoon-knife-repository)
Start by forking this repository. You can follow the [GitHub instructions](https://help.github.com/articles/fork-a-repo/).
The next step is to switch the origin URL to your fork; see [these GitHub instructions](https://help.github.com/articles/changing-a-remote-s-url/).
Then add an upstream remote pointing at the main [craftersoftware/craftercms](https://github.com/craftersoftware/craftercms) repo. Follow [these steps](https://help.github.com/articles/fork-a-repo/#step-3-configure-git-to-sync-your-fork-with-the-original-spoon-knife-repository)
to make it happen.
You can now work in your local system, and build/deploy and ultimately push to your fork. We welcome code contributions, so please do send us pull-requests.

To update your project with the latest:
To update your local clone with the latest:

```bash
./gradlew selfUpdate
Expand Down Expand Up @@ -362,7 +362,7 @@ To build the authoring and delivery environments, run the following:
The Gradle task above will:

1. Download the dependencies
2. Build all CrafterCMS modules from the source (check the [section](#git) on how to update the source)
2. Build all CrafterCMS modules from the source

- ``crafter-authoring``
- ``crafter-delivery``
Expand Down
8 changes: 4 additions & 4 deletions cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,16 +55,16 @@ For a detailed list of commands & arguments run `crafter-cli help`

## Contributors

https://github.com/craftercms/craftercms/blob/develop/CONTRIBUTORS.md
https://github.com/craftersoftware/craftercms/blob/develop/CONTRIBUTORS.md

## Code of Conduct

https://github.com/craftercms/craftercms/blob/develop/CODE_OF_CONDUCT.md
https://github.com/craftersoftware/craftercms/blob/develop/CODE_OF_CONDUCT.md

## Contributing

https://github.com/craftercms/craftercms/blob/develop/CONTRIBUTING.md
https://github.com/craftersoftware/craftercms/blob/develop/CONTRIBUTING.md

## Git Workflow

https://github.com/craftercms/craftercms/blob/develop/GIT_WORKFLOW.md
https://github.com/craftersoftware/craftercms/blob/develop/GIT_WORKFLOW.md
8 changes: 4 additions & 4 deletions commons/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ Crafter Commons. Learn more about CrafterCMS at https://craftercms.com/docs.

## Contributors

https://github.com/craftercms/craftercms/blob/develop/CONTRIBUTORS.md
https://github.com/craftersoftware/craftercms/blob/develop/CONTRIBUTORS.md

## Code of Conduct

https://github.com/craftercms/craftercms/blob/develop/CODE_OF_CONDUCT.md
https://github.com/craftersoftware/craftercms/blob/develop/CODE_OF_CONDUCT.md

## Contributing

https://github.com/craftercms/craftercms/blob/develop/CONTRIBUTING.md
https://github.com/craftersoftware/craftercms/blob/develop/CONTRIBUTING.md

## Git Workflow

https://github.com/craftercms/craftercms/blob/develop/GIT_WORKFLOW.md
https://github.com/craftersoftware/craftercms/blob/develop/GIT_WORKFLOW.md
8 changes: 4 additions & 4 deletions core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ Crafter Core content rendering library for CrafterCMS. For more information, ple

## Contributors

https://github.com/craftercms/craftercms/blob/develop/CONTRIBUTORS.md
https://github.com/craftersoftware/craftercms/blob/develop/CONTRIBUTORS.md

## Code of Conduct

https://github.com/craftercms/craftercms/blob/develop/CODE_OF_CONDUCT.md
https://github.com/craftersoftware/craftercms/blob/develop/CODE_OF_CONDUCT.md

## Contributing

https://github.com/craftercms/craftercms/blob/develop/CONTRIBUTING.md
https://github.com/craftersoftware/craftercms/blob/develop/CONTRIBUTING.md

## Git Workflow

https://github.com/craftercms/craftercms/blob/develop/GIT_WORKFLOW.md
https://github.com/craftersoftware/craftercms/blob/develop/GIT_WORKFLOW.md
8 changes: 4 additions & 4 deletions deployer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ Crafter Deployer is the deployment agent for CrafterCMS. Read the docs for more

## Contributors

https://github.com/craftercms/craftercms/blob/develop/CONTRIBUTORS.md
https://github.com/craftersoftware/craftercms/blob/develop/CONTRIBUTORS.md

## Code of Conduct

https://github.com/craftercms/craftercms/blob/develop/CODE_OF_CONDUCT.md
https://github.com/craftersoftware/craftercms/blob/develop/CODE_OF_CONDUCT.md

## Contributing

https://github.com/craftercms/craftercms/blob/develop/CONTRIBUTING.md
https://github.com/craftersoftware/craftercms/blob/develop/CONTRIBUTING.md

## Git Workflow

https://github.com/craftercms/craftercms/blob/develop/GIT_WORKFLOW.md
https://github.com/craftersoftware/craftercms/blob/develop/GIT_WORKFLOW.md
8 changes: 4 additions & 4 deletions engine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ Crafter Engine is the content rendering engine for CrafterCMS. For more informat

## Contributors

https://github.com/craftercms/craftercms/blob/develop/CONTRIBUTORS.md
https://github.com/craftersoftware/craftercms/blob/develop/CONTRIBUTORS.md

## Code of Conduct

https://github.com/craftercms/craftercms/blob/develop/CODE_OF_CONDUCT.md
https://github.com/craftersoftware/craftercms/blob/develop/CODE_OF_CONDUCT.md

## Contributing

https://github.com/craftercms/craftercms/blob/develop/CONTRIBUTING.md
https://github.com/craftersoftware/craftercms/blob/develop/CONTRIBUTING.md

## Git Workflow

https://github.com/craftercms/craftercms/blob/develop/GIT_WORKFLOW.md
https://github.com/craftersoftware/craftercms/blob/develop/GIT_WORKFLOW.md
25 changes: 12 additions & 13 deletions groovy-sandbox/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
groovy-sandbox
==============
# groovy-sandbox

Compile-time transformer to run Groovy code in a restrictive sandbox. Executes untrusted Groovy script safely.

[Documentation](http://groovy-sandbox.kohsuke.org/).

#### Maven dependency
## Maven dependency

```xml
<dependency>
Expand All @@ -25,7 +24,7 @@ Starting with version 1.20, this artifact is only published to the Jenkins Relea
</repository>
```

#### Usage
## Usage

A good example can be found [here](https://github.com/jenkinsci/groovy-sandbox/tree/master/src/test/groovy/org/kohsuke/groovy/sandbox/robot).
This is a simple test that always expects a `SecurityException`:
Expand All @@ -45,20 +44,20 @@ class Test {
}
```

# Community
## Community

## Contributors
### Contributors

https://github.com/craftercms/craftercms/blob/develop/CONTRIBUTORS.md
https://github.com/craftersoftware/craftercms/blob/develop/CONTRIBUTORS.md

## Code of Conduct
### Code of Conduct

https://github.com/craftercms/craftercms/blob/develop/CODE_OF_CONDUCT.md
https://github.com/craftersoftware/craftercms/blob/develop/CODE_OF_CONDUCT.md

## Contributing
### Contributing

https://github.com/craftercms/craftercms/blob/develop/CONTRIBUTING.md
https://github.com/craftersoftware/craftercms/blob/develop/CONTRIBUTING.md

## Git Workflow
### Git Workflow

https://github.com/craftercms/craftercms/blob/develop/GIT_WORKFLOW.md
https://github.com/craftersoftware/craftercms/blob/develop/GIT_WORKFLOW.md
2 changes: 1 addition & 1 deletion js-sdk/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@

### @craftercms/content
- Add ability to specify `flatten` for the `content_store/descriptor` endpoint (via the config argument of the function).
- Make `parseDescriptor` be able to handle the deserialization products of the [recent `crafter-source` & `crafter-source-content-type-id` attribute additions](https://github.com/craftercms/craftercms/issues/4093).
- Make `parseDescriptor` be able to handle the deserialization products of the [recent `crafter-source` & `crafter-source-content-type-id` attribute additions](https://github.com/craftersoftware/craftercms/issues/4093).

### @craftercms/ice
- [bugfix] Handle calls to `repaintPencils` before the dependency loader has been configured to avoid incorrect paths to load scripts/css from.
Expand Down
8 changes: 4 additions & 4 deletions js-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ Run `yarn test` on each of the packages to execute all tests.

# Community
## Contributors
https://github.com/craftercms/craftercms/blob/develop/CONTRIBUTORS.md
https://github.com/craftersoftware/craftercms/blob/develop/CONTRIBUTORS.md

## Code of Conduct
https://github.com/craftercms/craftercms/blob/develop/CODE_OF_CONDUCT.md
https://github.com/craftersoftware/craftercms/blob/develop/CODE_OF_CONDUCT.md

## Contributing
https://github.com/craftercms/craftercms/blob/develop/CONTRIBUTING.md
https://github.com/craftersoftware/craftercms/blob/develop/CONTRIBUTING.md

## Git Workflow
https://github.com/craftercms/craftercms/blob/develop/GIT_WORKFLOW.md
https://github.com/craftersoftware/craftercms/blob/develop/GIT_WORKFLOW.md
7 changes: 4 additions & 3 deletions js-sdk/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/craftercms/craftercms-sdk-js.git"
"url": "git+https://github.com/craftersoftware/craftercms.git",
"directory": "js-sdk"
},
"keywords": [
"content",
Expand All @@ -25,9 +26,9 @@
"author": "CrafterCMS",
"license": "LGPL-3.0",
"bugs": {
"url": "https://github.com/craftercms/craftercms/issues"
"url": "https://github.com/craftersoftware/craftercms/issues"
},
"homepage": "https://github.com/craftercms/craftercms-sdk-js#readme",
"homepage": "https://github.com/craftersoftware/craftercms/tree/develop/js-sdk#readme",
"devDependencies": {
"prettier": "^3.0.3",
"react": "^18.2.0",
Expand Down
3 changes: 2 additions & 1 deletion js-sdk/packages/classes/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"typings": "./classes.d.ts",
"repository": {
"type": "git",
"url": "https://github.com/craftercms/craftercms-sdk-js.git"
"url": "https://github.com/craftersoftware/craftercms.git",
"directory": "js-sdk/packages/classes"
},
"keywords": [
"content management",
Expand Down
2 changes: 1 addition & 1 deletion js-sdk/packages/content/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Parse a [Descriptor](../models/src/descriptor.ts), [Item](../models/src/item.ts)

### preParseSearchResults
Inspects and parses elasticsearch hits and pre-parses objects before they can be sent to parseDescriptor
@see https://github.com/craftercms/craftercms/issues/4057
@see https://github.com/craftersoftware/craftercms/issues/4057

```js
import { createQuery, search } from '@craftercms/search';
Expand Down
3 changes: 2 additions & 1 deletion js-sdk/packages/content/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"typings": "./content.d.ts",
"repository": {
"type": "git",
"url": "https://github.com/craftercms/craftercms-sdk-js.git"
"url": "https://github.com/craftersoftware/craftercms.git",
"directory": "js-sdk/packages/content"
},
"keywords": [
"content management",
Expand Down
3 changes: 2 additions & 1 deletion js-sdk/packages/ice/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"typings": "./ice.d.ts",
"repository": {
"type": "git",
"url": "https://github.com/craftercms/craftercms-sdk-js.git"
"url": "https://github.com/craftersoftware/craftercms.git",
"directory": "js-sdk/packages/ice"
},
"keywords": [
"In context editing",
Expand Down
Loading