Skip to content
DevelopmentJavaScript
About
Getting StartedContributing
Usage
AccountsAPI TokensAuthBusinessesBusiness InvitesEventsGraphQLGroupsMailboxesProductsInstancesStagesTemplatesTransitionsTranslationsUsersNetwork Connections
Architecture
AuthenticationSingletonsHTTP RequestsGraphQL
Development
API ClassesConfigurationEventsLoggingModelsUtilities
Documentation
Getting StartedContributingTechnical ComponentsStructureFirst Party ComponentsRecipe - Adding a PageRecipe - Adding Links
Tooling
BuildCoverageDebuggingLintingTesting
GitHub

Getting Started

Table of contents
New
View source
Table of contents

All documentation, including the framework and it's dependencies, are in the docs/ directory. This should be your working directory.

Environment

At present, you must use a copy of node locally on your machine to compile and use XEDI.js documentation. In the future, this will be containerized.

Due to runtime bug in node 14.3, one our dependencies is unable to build. As such, you must use either:

  • 10.20.1 (lts/dubnium)
  • 12.17.0 (lts/erbium)

As soon as this is rectified, this requirement will be removed.

Variables

To allow various functionalities of the documentation to work, a personal access token is required. This should be placed within a .env file in the root of the docs/ directory.

GITHUB_TOKEN=<my personal access token>

.env

Local Builds

The documentation framework ships with a development server that allows hotswap development.

npm run develop

Launching the development server

This triggers a build, followed by the provision of a localhost link. It defaults to port 8000, however if something is already using that port, the framework will use the next numerically available port.
If you are XEDI staff, when you go to http://localhost:8000 you may find that your browser automatically may redirect your to http://localhost:8000/dashboard. This is because Traefik, our development loadbalancer issues a 308 Permanent Redirect response when you go to http://localhost:8000

In this event, you will be greeted with a "Development 404" page. Simply select one of the pages in the site map displayed centrally in the page.

Edit this page on GitHub
1 contributorSmudge3806
Last edited by Smudge3806 on June 17, 2020