Skip to content

Commit

Permalink
Feat/ensono rebrand (#419)
Browse files Browse the repository at this point in the history
Co-authored-by: leesaxby <lee.saxby82@gmail.com>
Co-authored-by: George Wilde <george.wilde@ensono.com>
Co-authored-by: Elliot Evans <ell15evans.nuls@googlemail.com>
  • Loading branch information
4 people authored Sep 20, 2023
1 parent 1e99d02 commit 14b2d14
Show file tree
Hide file tree
Showing 212 changed files with 21,782 additions and 13,953 deletions.
28 changes: 14 additions & 14 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
Contributing
------------------

Thank you for considering contributing to [Amido](https://amido.com/) Stacks. It's people like you that continue to make Stacks the best it can be.
Thank you for considering contributing to [Ensono](https://www.ensonodigital.com) Stacks. It's people like you that continue to make Stacks the best it can be.

Following these guidelines helps you communicate and participate with the developers maintaining and developing these open source projects. We will cover:
* How to file issues
* How to raise a PR
* How to suggest a new feature


### Contributing to Amido Stacks
### Contributing to Ensono Stacks

We love to receive contributions. There are many ways in which you can experience the warm fuzzies of open source contribution, from improving the documentation, writing tutorials or blog posts, submitting issues and feature requests, or writing code which can be incorporated into Amido Stacks.
We love to receive contributions. There are many ways in which you can experience the warm fuzzies of open source contribution, from improving the documentation, writing tutorials or blog posts, submitting issues and feature requests, or writing code which can be incorporated into Ensono Stacks.

However, we have a few baselines worth noting:
* Please don't expect your new feature to be implemented unless you or someone else sends a pull request. Submit with a test to get it merged quicker.
* If you have an issue, please tell us how to reproduce it. Bonus points for a failing test case.
* Not everything will be fixed.
* Did we mention we love tests?

Please, don't use the issue tracker if your problem is not strictly Amido Stacks specific. Stack Overflow or other sources are worth considering.
Please, don't use the issue tracker if your problem is not strictly Ensono Stacks specific. Stack Overflow or other sources are worth considering.

_See the individual [Amido projects](./README.md) for in depth information about environment setup, testing, and code styles._
_See the individual [Ensono projects](./README.md) for in depth information about environment setup, testing, and code styles._

# First...
Please read our [Code of Conduct](./CODE_OF_CONDUCT.md).
Expand All @@ -35,10 +35,10 @@ The basis of all is to remember to do good humaning. Everyone is on their own pa
* Tests aren't optional

# How to contribute
Unsure where to being? Start by looking through the following [issues](https://github.com/amido/amido.github.io/issues?q=is%3Aissue+is%3Aopen+sort%3Acomments-desc) labels:
Unsure where to being? Start by looking through the following [issues](https://github.com/Ensono/amido.github.io/issues?q=is%3Aissue+is%3Aopen+sort%3Acomments-desc) labels:

* [good-first-issue](https://github.com/amido/amido.github.io/labels/good-first-issue) - should only require a few lines of code, and a test or two.
* [documentation](https://github.com/amido/amido.github.io/labels/kind%2Fdocumentation) - we always need to improve our documentation, it's one of the best ways to contribute.
* [good-first-issue](https://github.com/Ensono/amido.github.io/labels/good-first-issue) - should only require a few lines of code, and a test or two.
* [documentation](https://github.com/Ensono/amido.github.io/labels/kind%2Fdocumentation) - we always need to improve our documentation, it's one of the best ways to contribute.

Sorting the issues by number of comments generally gives a reasonable proxy for the impact the change will have. More comments, more vested interest.

Expand All @@ -48,22 +48,22 @@ No problem! You can learn how from this *free* series, [How to Contribute to an
Alternatively, ask us for help.

# Open Development
All work on Amido Stacks is on GitHub. Both Amido maintainers and external contributors send pull requests which go through the same review process. We are using [Azure Pipelines](https://azure.microsoft.com/en-gb/services/devops/pipelines/) as our CI/CD tool of choice. Every PR will invoke a series of steps to build, test, and deploy.
All work on Ensono Stacks is on GitHub. Both Ensono maintainers and external contributors send pull requests which go through the same review process. We are using [Azure Pipelines](https://azure.microsoft.com/en-gb/services/devops/pipelines/) as our CI/CD tool of choice. Every PR will invoke a series of steps to build, test, and deploy.

## Code changes happen through pull requests
We use Github for hosting and supporting our open source Stack projects. The Amido internal maintainers team will be monitoring Github for pull requests (PRs) and issues.
We use Github for hosting and supporting our open source Stack projects. The Ensono internal maintainers team will be monitoring Github for pull requests (PRs) and issues.

We actively welcome your pull requests:

1. Fork the repo and create your branch from master
2. If you've added code that should be tested, add tests.
3. Update the documentation.
4. Ensure the test suite passes.
5. Issue the pull request using the repos PULL_REQUEST_TEMPLATE.md. It's important to link the [issue number](https://github.com/amido/amido.github.io/issues) to ensure that the Issue is closed.
5. Issue the pull request using the repos PULL_REQUEST_TEMPLATE.md. It's important to link the [issue number](https://github.com/Ensono/amido.github.io/issues) to ensure that the Issue is closed.

## How to report a bug
### Security first
If you find a security vulnerability, do NOT open an [issue](https://github.com/amido/amido.github.io/issues/new/choose). Email [Amido](mailto:stacks@amido.com) instead.
If you find a security vulnerability, do NOT open an [issue](https://github.com/Ensono/amido.github.io/issues/new/choose). Email [Ensono](mailto:stacks@ensono.com) instead.

If you aren't sure you've found an security issue, ask yourself the following:
1. Can I access something that is not mine?
Expand All @@ -72,7 +72,7 @@ If you aren't sure you've found an security issue, ask yourself the following:
If you answered "yes" to either question, please get in contact.

### Report bugs using Github issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue. Please follow the [issue templates](https://github.com/amido/amido.github.io/tree/master/.github/ISSUE_TEMPLATE).
We use GitHub issues to track public bugs. Report a bug by opening a new issue. Please follow the [issue templates](https://github.com/Ensono/amido.github.io/tree/master/.github/ISSUE_TEMPLATE).

In general, please follow the guidelines:
* A quick summary and/or background
Expand All @@ -91,7 +91,7 @@ For versioning, we follow [Semantic Version 2.0.0](https://semver.org/).
Code styling and practices depend on the project. Check the project repo for more information.

# Community
If you are interested in talking with Amido on how accelerate your cloud adoption using Amido Stacks then please reach out at [Amido](mailto:london@amido.com).
If you are interested in talking with Ensono on how accelerate your cloud adoption using Ensono Stacks then please reach out at [Ensono](mailto:stacks@ensono.com).

*************************
_Special thanks to the open-source inspirations we've loved and used to form our own documentation:
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE-TRIAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ If you don't have time to contribute or you are not an active maintainer, consid

## Classify the issue

An issue can have one more [labels](https://github.com/amido/amido.github.io/labels), including:
An issue can have one more [labels](https://github.com/Ensono/amido.github.io/labels), including:

- One label identifying its kind (`kind/*`).
- One or multiple labels identifying the functional areas of interest (`area/*`).
Expand Down Expand Up @@ -91,7 +91,7 @@ An issue can have one more [labels](https://github.com/amido/amido.github.io/lab


## Prioritising issues
When an issue is raised, it should be [labelled](https://github.com/amido/amido.github.io/labels?utf8=%E2%9C%93&q=priority) with the following labels to indicate the degree of priority (from more urgent to less urgent).
When an issue is raised, it should be [labelled](https://github.com/Ensono/amido.github.io/labels?utf8=%E2%9C%93&q=priority) with the following labels to indicate the degree of priority (from more urgent to less urgent).

Please note that maintainers an contributors have the right to change the priority based on the issue description and supporting information therefore it's important to triage the issue appropriately. Any changes to priority will be transparent and communicated appropriately.

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Bug report
about: Create a report to help us improve Amido Stacks
about: Create a report to help us improve Ensono Stacks
title: ''
labels: ''
assignees: ''
Expand Down
39 changes: 39 additions & 0 deletions .github/workflows/deployment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
permissions:
contents: write
name: stacks.website
on:
push:
branches:
master
jobs:
build:
name: Install packages and build application
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v4
- name: Use NodeJS
uses: actions/setup-node@v3
with:
node-version: 16.14.x
- name: Install Dependencies
run: npm install
- name: Build application
run: npm run build
env:
ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME }}
ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
- name: Upload Artifact
uses: actions/upload-artifact@main
with:
name: github-pages
path: ./build
if-no-files-found: warn
- name: Deploy to GitHub Pages
id: deployment
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: build
clean: true
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ yarn-debug.log*
yarn-error.log*
.vscode/*
.vs/*
.env
6 changes: 3 additions & 3 deletions .spelling
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Amido
Ensono
Next.js
SonarCloud
Github
SonarLint
SonarScanner
amidostacks
ensonostacks
SonarQube
xUnit
ClassName
Expand All @@ -25,7 +25,7 @@ workermap
javascript
testcafe
teardown
amido
ensono
readme.md
devops
yaml
Expand Down
32 changes: 21 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ensono Stacks Documentation Microsite
This repository contains the documentation for the Ensono Stacks platform.
The live site is hosted at [https://stacks.amido.com](https://stacks.amido.com).
The live site is hosted at [https://stacks.ensono.com](https://stacks.ensono.com).

This microsite is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
You can view their documentation [here](https://v2.docusaurus.io/docs/).
Expand All @@ -15,18 +15,28 @@ npm run start
You can then edit the relevant markdown files in the `docs` folder and the site will automatically update.
Once you are happy with your changes, you can commit them to a new branch and open a pull request.

## Search functionality
The search functionality is using (Algolia DocSearch)[https://docusaurus.io/docs/search#using-algolia-docsearch] and the search component has been swizzle (It is in src/theme/SearchBar.js) because the version of docusaurus is using an old infrastructure so the search bar is not able to search anything in the documentation. It is using @docsearch/react which is the new infrastructure.

AppId, indexName and apiKey is needed to get the search functionality working, and this data is in the dashboard.

The dashboard for Algolia - an overview of the search (https://dashboard.algolia.com/)
Configure the Algolia Crawler - https://crawler.algolia.com/

The login email is `stacks@ensono.com`

### Stacks Repositories
These are the repositories that make up the Stacks platform:
- [Stacks Webapp Template](https://github.com/amido/stacks-webapp-template)
- [Stacks .NET](https://github.com/amido/stacks-dotnet)
- [Stacks Java](https://github.com/amido/stacks-java)
- [Stacks Java with CQRS](https://github.com/amido/stacks-java-cqrs)
- [Stacks Java with CQRS and Events](https://github.com/amido/stacks-java-cqrs-events)
- [Stacks Frontend](https://github.com/amido/stacks-nx-plugins)
- [Stacks Pipeline Templates](https://github.com/amido/stacks-pipeline-templates)
- [Stacks Terraform](https://github.com/amido/stacks-terraform)
- [Stacks Azure Infrastructure](https://github.com/amido/stacks-infrastructure-aks)
- [Stacks Azure Data Platform](https://github.com/amido/stacks-azure-data)
- [Stacks Webapp Template](https://github.com/Ensono/stacks-webapp-template)
- [Stacks .NET](https://github.com/Ensono/stacks-dotnet)
- [Stacks Java](https://github.com/Ensono/stacks-java)
- [Stacks Java with CQRS](https://github.com/Ensono/stacks-java-cqrs)
- [Stacks Java with CQRS and Events](https://github.com/Ensono/stacks-java-cqrs-events)
- [Stacks Frontend](https://github.com/Ensono/stacks-nx-plugins)
- [Stacks Pipeline Templates](https://github.com/Ensono/stacks-pipeline-templates)
- [Stacks Terraform](https://github.com/Ensono/stacks-terraform)
- [Stacks Azure Infrastructure](https://github.com/Ensono/stacks-infrastructure-aks)
- [Stacks Azure Data Platform](https://github.com/Ensono/stacks-azure-data)

### Packages
- [NuGet](https://www.nuget.org/profiles/amidostacks)
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ As per the [Docusaursus documentation](https://docusaurus.io/docs/en/doc-markdow

To reduce the size of the monorepo, we instead insist on ALL assets to be hosted publically.

## Amido Maintainers
## Ensono Maintainers

If you have access to the `Amido.Stacks` subscription in Azure, under the `amido-stacks-assets` resource group there is a Storage Account named `amidostacksassets`. This contains `docs` a _public read only storage container_ under which you may upload all static assets to the `assets` folder.

Expand Down
2 changes: 1 addition & 1 deletion docs/assets/asciinema/scaffolding-cli-testcafe-ascii.cast
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
[20.992573, "o", "\u001b[36m?\u001b[39m \u001b[1mSelect Pipeline Tool\u001b[22m \u001b[90m›\u001b[39m \u001b[90m- Use arrow-keys. Return to submit.\u001b[39m\r\n\u001b[36m❯\u001b[39m \u001b[36m\u001b[4mAzureDevOps\u001b[39m\u001b[24m\u001b[90m - Azure Devops/VSTS/TFS\u001b[39m\r\n Jenkins\u001b[90m\u001b[39m\r\n"]
[22.262815, "o", "\u001b[2K\u001b[1A\u001b[2K\u001b[1A\u001b[2K\u001b[1A\u001b[2K\u001b[G"]
[22.262974, "o", "\u001b[32m✔\u001b[39m \u001b[1mSelect Pipeline Tool\u001b[22m \u001b[90m›\u001b[39m AzureDevOps\r\n\u001b[?25h"]
[22.582171, "o", "Your Typescript TestCafe Testing Framework has been created. To get started: \r\n\r\n---- \r\n\r\ncd projectname && npm install && npm run test \r\n\r\n---- \r\nyour selected configuration and additional project default has been saved to /Users/estherlloyd/projectname.bootstrap-config.json. To change provided default configuration please edit and rerun. See <> for more info\r\n \r\n\r\n👟 Next steps: check out your bootstapped project in your chosen development environment\r\n cd /Users/estherlloyd/projectname\r\n\r\n🤓 To get started: open /Users/estherlloyd/projectname/README.md\r\n\r\n📖 For guides and supporting information see: https://stacks.amido.com/\r\n\r\n💻 Thank you for using the Amido Stacks scaffolding-cli!\r\n To contribute: https://github.com/amido/amido.github.io\r\n\r\n"]
[22.582171, "o", "Your Typescript TestCafe Testing Framework has been created. To get started: \r\n\r\n---- \r\n\r\ncd projectname && npm install && npm run test \r\n\r\n---- \r\nyour selected configuration and additional project default has been saved to /Users/estherlloyd/projectname.bootstrap-config.json. To change provided default configuration please edit and rerun. See <> for more info\r\n \r\n\r\n👟 Next steps: check out your bootstapped project in your chosen development environment\r\n cd /Users/estherlloyd/projectname\r\n\r\n🤓 To get started: open /Users/estherlloyd/projectname/README.md\r\n\r\n📖 For guides and supporting information see: https://stacks.amido.com/\r\n\r\n💻 Thank you for using the Ensono Stacks scaffolding-cli!\r\n To contribute: https://github.com/Ensono/amido.github.io\r\n\r\n"]
[22.586332, "o", "bash-3.2$ "]
[24.177891, "o", "c"]
[24.344349, "o", "d"]
Expand Down
Loading

0 comments on commit 14b2d14

Please sign in to comment.