Skip to main content

Academy Link Operations Guide

This guide explains how to create and manage EcoWorld Academy course links.

Course links use the format:

https://academy.ecoworld.ai/

Example:

https://academy.ecoworld.ai/x4zktada

When someone visits this link, they are automatically redirected to the correct course on LearnWorlds.


Instead of linking manuals and documents directly to LearnWorlds, we use a stable redirect link.

Benefits:

  • Links in documentation never break
  • Course URLs can change without updating manuals
  • All course links are managed centrally
  • Analytics can track course traffic
  • Links remain short and clean

Academy links are used in:

  • EcoWorld manuals
  • Documentation
  • Training programs
  • Internal onboarding material
  • Customer education resources

Creating a course link involves three simple steps.


Step 1 — Generate a course code

Each course needs a short unique code.

Example:

x4zktada

Codes should:

  • Be 8 characters
  • Use letters and numbers
  • Be random
  • Not contain spaces

Example codes:

k29fd8s2 x4zktada pq3f8rka b7a2lm9x

Codes can be generated in Excel.


Create a new file inside the repository:

seed/.json

Example:

seed/x4zktada.json

Example contents:

{
"code": "x4zktada",
"target_url": "https://ecoworld-academy.learnworlds.com/course/esrs-e1",
"status": "draft",
"label": "ESRS E1 Masterclass",
"locale": "en",
"version": 1,
"allow_params": true,
"host_allowlist": ["*.learnworlds.com"]
}

Only two fields must always be correct:

FieldDescription
codeThe short link code
target_urlThe LearnWorlds course URL

Step 3 — Push to the repository

After the file is created, push it to the repository.

git add seed/x4zktada.json
git commit -m "Add ESRS E1 course"
git push

The system automatically updates the redirect system.

No deployment is required.


Publishing a course

When a course is ready for public use:

Change:

"status": "draft"

to

"status": "live"

Then commit and push the change.


Viewing the course catalog

You can see all registered course links here:

https://academy.ecoworld.ai/catalog

The catalog displays:

  • Course code
  • Course name
  • Status
  • Destination URL

Access to the catalog is restricted to internal staff.


After creating a link, test it.

Example:

https://academy.ecoworld.ai/x4zktada

Expected result:

The page redirects to the LearnWorlds course.


Sometimes the LearnWorlds URL may change.

To update it:

  1. Open the JSON file
  2. Replace the target_url
  3. Increase the version number

Example:

"version": 2

Then commit and push the update.


Archiving a course

If a course should no longer be used:

Change the status to:

"archived"

This prevents the course from appearing as active in the catalog.


Common mistakes

Avoid the following mistakes.

Incorrect course URL

Always test the LearnWorlds link first.

Duplicate codes

Every course must have a unique code.

Forgetting to update the status

Courses should move from:

draft → live → archived


Best practices

Recommended practices:

  • Use 8 character codes
  • Keep course labels clear
  • Test every link after creation
  • Always use Academy links in documentation
  • Never link manuals directly to LearnWorlds

When to contact the development team

Contact the development team if:

  • Links do not redirect
  • The catalog page is unavailable
  • A link must be updated urgently
  • A large number of courses need importing

Summary

The Academy Link system ensures that all EcoWorld Academy courses have stable and manageable URLs.

This protects documentation from broken links and allows courses to evolve without affecting training materials.




GitHub RepoRequest for Change (RFC)