Skip to content

Commit

Permalink
Updated docs to use DrevOps Scaffold when referencing Scaffold.
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexSkrypnyk committed May 9, 2024
1 parent 15972e1 commit 0666356
Show file tree
Hide file tree
Showing 20 changed files with 156 additions and 131 deletions.
2 changes: 1 addition & 1 deletion .env.local.default
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ DREVOPS_PROVISION_OVERRIDE_DB=1
# Override only if you need to use a different URL than the default.
# DREVOPS_LOCALDEV_URL="your_site.docker.amazee.io"

# Print debug information in DrevOps scripts.
# Print debug information in DrevOps Scaffold scripts.
# DREVOPS_DEBUG=1

#;< !PROVISION_USE_PROFILE
Expand Down
9 changes: 3 additions & 6 deletions .scaffold/.ahoy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,6 @@ commands:
lint-dockerfiles:
cmd: ./tests/lint.dockerfiles.sh

lint-docs:
cmd: |
npm --prefix=./docs ci
npm --prefix=./docs run test
test:
name: Test Scaffold project.
cmd: |
Expand All @@ -37,7 +32,9 @@ commands:
cmd: ./tests/test.workflow.sh

test-docs:
cmd: ahoy docs build && ahoy docs test
cmd: |
npm --prefix=./docs ci
npm --prefix=./docs run test
# If there are changes to the fixtures - this command will re-run twice reporting error the first time.
update-fixtures:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ DREVOPS_LOCALDEV_URL="<current_dir>.docker.amazee.io"
# Set to `1` to override existing downloaded DB dump without asking.
DREVOPS_DB_DOWNLOAD_FORCE=

# Set to `1` to print debug information in DrevOps scripts.
# Set to `1` to print debug information in DrevOps Scaffold scripts.
DREVOPS_DEBUG=

# Set to `y` to suppress Ahoy prompts.
Expand Down
12 changes: 6 additions & 6 deletions .scaffold/docs/content/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ sidebar_position: 1
</picture>
</div>

DrevOps is a project scaffold for [Drupal](https://drupal.org) that is designed
DrevOps Scaffold is a project template for [Drupal](https://drupal.org) that is designed
to streamline the development process for building high-quality Drupal websites.

The template is validated through automated tests, ensuring all tooling and
Expand All @@ -33,7 +33,7 @@ for developers to switch between projects and get up to speed quickly.

Refer to [Features](getting-started/features.mdx) for more details.

## Why DrevOps?
## Why DrevOps Scaffold?

There are many ways to build a Drupal website. The ecosystem is rich with
options, but there are not many places to find all the tools and workflows
Expand All @@ -47,17 +47,17 @@ inheriting the same configuration or workflow bugs. Then, when new tools may
need to be introduced, you'll have to manually add them to the project, which
can be time-consuming and error-prone.

Enter DrevOps.
Enter DrevOps Scaffold.

We've created a project template that eliminates the guesswork: all the
essential tools and workflows are already in place, fine-tuned, and vetted
through rigorous automated tests.

Using DrevOps also provides a place to test workflows and tools independently,
Using DrevOps Scaffold also provides a place to test workflows and tools independently,
away from high-stakes production projects. It’s a proactive approach to catch
potential regressions early on.

With DrevOps, consistency is key. We aim for a smooth developer experience
With DrevOps Scaffold, consistency is key. We aim for a smooth developer experience
across multiple projects, ensuring you're familiar with the structure
and documentation from one project to the next. It's about making things
efficient without compromising on quality.
Expand Down Expand Up @@ -86,5 +86,5 @@ Refer to [Contributing](contributing) for more details.

## License

DrevOps project scaffold is licensed under the GPL-3.0 license. See
DrevOps Scaffold is licensed under the GPL-3.0 license. See
the [LICENSE](https://github.com/drevops/scaffold/blob/develop/LICENSE) file for more details.
14 changes: 8 additions & 6 deletions .scaffold/docs/content/contributing/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@ sidebar_position: 1

# Contributing

DrevOps is an open source project. There are numerous ways to contribute to
DrevOps whether you’re a developer or a non-technical user.
DrevOps Scaffold is an open source project. There are numerous ways to
contribute to DrevOps Scaffold whether you’re a developer or a non-technical
user.

## What forms of contribution are we looking for?

Any form of contribution to DrevOps, be it rectifying a bug, proposing a new
feature, or enhancing our documentation, is highly appreciated. We are glad for
your willingness to assist!
Any form of contribution to DrevOps Scaffold, be it rectifying a bug, proposing
a new feature, or enhancing our documentation, is highly appreciated. We are
glad for your willingness to assist!

## I've discovered a problem

Expand All @@ -24,7 +25,8 @@ already been reported in the [issue queue](https://github.com/drevops/scaffold/i

Fantastic! Please [submit your idea](https://github.com/drevops/scaffold/issues)
and we'll gladly review it. While we can't promise every suggestion will be
implemented, we are always keen to hear innovative ideas for enhancing DrevOps.
implemented, we are always keen to hear innovative ideas for enhancing
the DrevOps Scaffold.

## Talk to us on Slack

Expand Down
29 changes: 15 additions & 14 deletions .scaffold/docs/content/contributing/maintenance/documentation.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
# Authoring documentation

There are 2 types of the documentation that DrevOps provides:
There are 2 types of the documentation that DrevOps Scaffold provides:

1. This Documentation of DrevOps that is then deployed
1. This Documentation of DrevOps Scaffold that is then deployed
to https://docs.drevops.com/
2. Consumer site documentation that is distributed when DrevOps is installed.
2. Consumer site documentation that is distributed when DrevOps Scaffold is
installed.

## docs.drevops.com

The Documentation (this site) is written in Markdown and located in
[`.scaffold/docs`](https://github.com/drevops/scaffold/blob/develop/.scaffold/docs) directory. This is
removed when you install DrevOps for a
removed when you install DrevOps Scaffold for a
consumer site.

### Local build
Expand All @@ -24,19 +25,18 @@ Parts of the documentation is generated automatically from the codebase.
To update it, run:

```bash
composer -d .scaffold/docs/.utils install
cd .scaffold/docs
ahoy update
cd .scaffold
ahoy update-docs
```

If you have the documentation site running locally, the updates will be seen
immediately.
If you have the documentation site running locally, the content changes will
be available immediately.

### Check spelling and links

```bash
cd .scaffold/docs
ahoy test
cd .scaffold
ahoy test-docs
```

If required, add spelling exclusions to `.scaffold/docs/cspell.json`
Expand All @@ -53,10 +53,11 @@ An automated CI build publishes this documentation.

## Consumer site documentation

DrevOps provides a scaffold of the consumer site documentation in the
DrevOps Scaffold provides a scaffold of the consumer site documentation in the
[`docs`](https://github.com/drevops/scaffold/blob/develop/docs) directory.

After DrevOps is installed into the consumer site, these docs are intended to
be used by the site maintainers and stay up-to-date with the project changes.
After DrevOps Scaffold is installed into the consumer site, these docs are
intended to be used by the site maintainers and stay up-to-date with the
project changes.

See [Documentation](../../workflows/documentation.mdx) section.
12 changes: 6 additions & 6 deletions .scaffold/docs/content/contributing/maintenance/scripts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ pass "Finished GitHub notification for operation ${DREVOPS_NOTIFY_EVENT}"
16. MAY rely on variables from the external scripts (not prefixed with a
script-specific prefix), but MUST declare such variables in the header of
the file.
17. MAY call other DrevOps scripts (discouraged), but MUST source them rather
17. MAY call other DrevOps Scaffold scripts (discouraged), but MUST source them rather
than creating a sub-process. This is to allow passing environment variables
down the call stack.
18. SHOULD use `note` messages for informing about the script progress.
Expand All @@ -82,19 +82,19 @@ Follow these guidelines when creating or updating DrevOps variables.
1. Local variables MUST be in lowercase, and global variables MUST be in
uppercase.

2. All DrevOps variables MUST start with `DREVOPS_` to separate DrevOps from
2. All DrevOps Scaffold variables MUST start with `DREVOPS_` to separate DrevOps from
third-party variables.

3. Global variables MAY be re-used as-is across scripts. For instance, the
`DREVOPS_WEBROOT` variable is used in several scripts.

4. DrevOps action-specific script variables MUST be scoped within their own
4. DrevOps Scaffold action-specific script variables MUST be scoped within their own
script. For instance, the `DREVOPS_PROVISION_OVERRIDE_DB`
variable in the `provision.sh`.

5. Drupal-related variables SHOULD start with `DRUPAL_` and SHOULD have a module
name added as a second prefix. This is to separate DrevOps, third-party
services variables, and Drupal variables. For instance, to set
name added as a second prefix. This is to separate DrevOps Scaffold,
third-party services variables, and Drupal variables. For instance, to set
a user for Drupal's Shield module configuration, use `DRUPAL_SHIELD_USER`.

6. Variables SHOULD NOT be exported into the global scope unless absolutely
Expand All @@ -103,7 +103,7 @@ Follow these guidelines when creating or updating DrevOps variables.

## Boilerplate script

Use the boilerplate script below to kick-start your custom DrevOps script.
Use the boilerplate script below to kick-start your custom DrevOps Scaffold script.

import CodeBlock from '@theme/CodeBlock';
import MyComponentSource from '!!raw-loader!./script-boilerplate.sh';
Expand Down
4 changes: 2 additions & 2 deletions .scaffold/docs/content/contributing/maintenance/tests.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Authoring tests

DrevOps uses [Bats](https://github.com/bats-core/bats-core) for testing.
DrevOps Scaffold uses [Bats](https://github.com/bats-core/bats-core) for testing.
Bats is a TAP-compliant testing framework for Bash. It provides a simple way to
verify that the UNIX programs you write behave as expected.

Expand Down Expand Up @@ -42,7 +42,7 @@ Some tests use test fixtures such as Drupal database snapshots.

### Updating demo database file dump

1. Run fresh build of DrevOps locally:
1. Run fresh build of DrevOps Scaffold locally:
```bash
echo "DRUPAL_PROFILE=standard">>.env.local
echo "DREVOPS_PROVISION_USE_PROFILE=1">>.env.local
Expand Down
14 changes: 10 additions & 4 deletions .scaffold/docs/content/contributing/roadmap.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,16 @@ bug fixes required.

## Current goals

1. Introduction of the DDEV and Lando for local development.
2. Introduction of the GitHub Actions for CI/CD as alternative to CircleCI.
3. Replacing Ahoy with Task.
4. Improving installation and update process.
:::note

DrevOps Scaffold 2.0 is coming soon!

:::

1. Improving installation and update process to use `composer create-project`.
2. Introduction of the DDEV and Lando for local development.
3. Introduction of the GitHub Actions for CI/CD as alternative to CircleCI.
4. Replacing Ahoy with Task.
5. Increasing test coverage for scripts.

## Future goals
Expand Down
6 changes: 3 additions & 3 deletions .scaffold/docs/content/drupal/composer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ provides a starter kit for managing your site dependencies with Composer.
Scaffold extends the Drupal Composer project's `composer.json` to support
additional features and tools.

DrevOps team will keep the `composer.json` file up-to-date with the latest
version of the `composer.json` in the Drupal Composer project, so you can always
make sure you are using the best community practices.
DrevOps Scaffold team will keep the `composer.json` file up-to-date with the
latest version of the `composer.json` in the [Drupal Composer project](https://github.com/drupal-composer/drupal-project),
so you can always make sure you are using the best community practices.

## `composer.json`

Expand Down
6 changes: 3 additions & 3 deletions .scaffold/docs/content/drupal/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -135,12 +135,12 @@ functionality.

## Testing settings with unit tests

DrevOps provides a [set of unit tests](https://github.com/drevops/scaffold/blob/develop/tests/phpunit/Drupal) that
DrevOps Scaffold provides a [set of unit tests](https://github.com/drevops/scaffold/blob/develop/tests/phpunit/Drupal) that
ensure that the settings apply correctly per environment. These tests are
supposed to be maintained within your project, ensuring that settings activated
by specific environments and environment variables are applied accurately.

After installing DrevOps, run `vendor/bin/phpunit --group=drupal_settings` to
run the tests for the settings provided by DrevOps.
After installing DrevOps Scaffold, run `vendor/bin/phpunit --group=drupal_settings` to
run the tests for the settings provided by DrevOps Scaffold.

You may simply remove these tests if you do not want to maintain them.
10 changes: 5 additions & 5 deletions .scaffold/docs/content/getting-started/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Scaffold offers a pre-configured project template that is reliable, tested and
ready-to-use. Its main goal is to streamline onboarding, making it as quick and
efficient as possible.

## Zen of DrevOps
## Zen of DrevOps Scaffold

Similar to [Zen of Python](https://www.python.org/dev/peps/pep-0020/), DrevOps
Similar to [Zen of Python](https://www.python.org/dev/peps/pep-0020/), DrevOps Scaffold
has its own set of principles.

* Simple is better than complex.
Expand Down Expand Up @@ -55,10 +55,10 @@ with addition of several configuration files and directories.
β”‚ β”œβ”€β”€ library # Library of hook implementations.
β”‚ └── prod # Hook implementations that run in prod environment.
β”œβ”€β”€ patches # Patches for packages.
β”œβ”€β”€ scripts # Composer, DrevOps and custom project scripts.
β”œβ”€β”€ scripts # Composer, DrevOps Scaffold and custom project scripts.
β”‚ β”œβ”€β”€ composer # Composer scripts.
β”‚ β”œβ”€β”€ custom # Custom project scripts.
β”‚ └── drevops # DrevOps workflow scripts.
β”‚ └── drevops # DrevOps Scaffold workflow scripts.
β”œβ”€β”€ tests # Integration and configuration tests.
β”‚ β”œβ”€β”€ behat # Behat BDD tests.
β”‚ └── phpunit # Configuration unit tests
Expand All @@ -75,7 +75,7 @@ with addition of several configuration files and directories.
β”œβ”€β”€ .ahoy.local.example.yml # Ahoy local configuration file.
β”œβ”€β”€ .dockerignore # Docker ignore configuration file.
β”œβ”€β”€ .editorconfig # Helps maintain consistent coding styles.
β”œβ”€β”€ .env # Environment variables to control project workflow using DrevOps variables.
β”œβ”€β”€ .env # Environment variables to control project workflow using variables.
β”œβ”€β”€ .env.local.default # Environment variables local overrides.
β”œβ”€β”€ .gitignore # Intentionally untracked files to ignore in Git.
β”œβ”€β”€ .gitignore.artifact # Intentionally untracked files to ignore in artifact deployment.
Expand Down
Loading

1 comment on commit 0666356

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.