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.

Sign up for GitHub

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

Jump to bottom

fix: doc setup update #5

Merged
merged 1 commit into from Mar 26, 2024
Merged

fix: doc setup update #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
@@ -1,6 +1,14 @@
# aem-seo-research
Misc SEO research

## Setup
Create .env file with the following content:
```
SPACECAT_API_KEY=
AHREFS_API_KEY=
```
Retrieve the values from [Vault](https://vault-amer.adobe.net/ui/vault/secrets/aem_exp_success_eng/show/spacecat/seo).

## How to trigger all assessments

`npm run all <baselUrl>`
Expand Down
7 changes: 4 additions & 3 deletions assessment/README.md
View file
Open in desktop
@@ -1,9 +1,10 @@
# SEO assessment

## How to
## Setup

Run all assessments sequentially. Every assessment shall return a CSV that can be copy/pasted into the overall assessment.
Every assessment requires an URL as first parameter. The URL must be contained in SpaceCat Catalogue.
- Run all assessments sequentially.
- Every assessment shall return a CSV that can be copy/pasted into the overall assessment.
- Every assessment requires a URL as first parameter. The URL must exist within the SpaceCat Catalogue.

Example: `node ./assessment/sitemap.js "https://bitdefender.com.au/solutions/"`

Expand Down