From 6d1ea6ca9b4efb4e5bb5096a3ae9ed1c11fabe9f Mon Sep 17 00:00:00 2001 From: Steve Hamrick Date: Mon, 13 Jan 2020 08:03:38 -0700 Subject: [PATCH 1/4] Clarify Traffic Portal development instructions --- docs/source/development/traffic_portal.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/source/development/traffic_portal.rst b/docs/source/development/traffic_portal.rst index 845f60529e..ee58f40e30 100644 --- a/docs/source/development/traffic_portal.rst +++ b/docs/source/development/traffic_portal.rst @@ -45,5 +45,7 @@ Installing The Traffic Portal Developer Environment #. Run ``npm install`` to install application dependencies into ``traffic_portal/node_modules``. Only needs to be done the first time unless ``traffic_portal/package.json`` changes. #. Run ``bower install`` to install client-side dependencies into ``traffic_portal/app/bower_components``. Only needs to be done the first time unless ``traffic_portal/bower.json`` changes. #. Run ``grunt`` to package the application into ``traffic_portal/app/dist``, start a local HTTPS server (Express), and start a file watcher. -#. Valid SSL certificates and keys are needed for Traffic Portal to run. Generate these (e.g. using `this SuperUser answer `_) and edit the ``traffic_portal/conf/config.js`` file to reflect their names and locations +#. Modify ``traffic_portal/conf/config.js``: + #. Valid SSL certificates and keys are needed for Traffic Portal to run. Generate these (e.g. using `this SuperUser answer `_) and update ``ssl``. + #. Modify ``api``, ``files``, ``log`` as appropriate #. Navigate to http(s)://localhost:[port|sslPort defined in ``traffic_portal/conf/config.js``] From 0c990f70c251403c332debe915e7c41480d5df4d Mon Sep 17 00:00:00 2001 From: Steve Hamrick Date: Mon, 13 Jan 2020 08:42:26 -0700 Subject: [PATCH 2/4] Further clarifications --- docs/source/development/traffic_portal.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/source/development/traffic_portal.rst b/docs/source/development/traffic_portal.rst index ee58f40e30..17f32b2ad8 100644 --- a/docs/source/development/traffic_portal.rst +++ b/docs/source/development/traffic_portal.rst @@ -47,5 +47,7 @@ Installing The Traffic Portal Developer Environment #. Run ``grunt`` to package the application into ``traffic_portal/app/dist``, start a local HTTPS server (Express), and start a file watcher. #. Modify ``traffic_portal/conf/config.js``: #. Valid SSL certificates and keys are needed for Traffic Portal to run. Generate these (e.g. using `this SuperUser answer `_) and update ``ssl``. - #. Modify ``api``, ``files``, ``log`` as appropriate + #. Modify ``api.base_url`` to point to your Traffic Ops API endpoint. + #. Modify ``files.static`` to be ``./app/dist/public``. + #. Modify ``log.stream`` to be ``./server/log/access.log``. #. Navigate to http(s)://localhost:[port|sslPort defined in ``traffic_portal/conf/config.js``] From 372c687e4e7c80cae93c638e387429585c916808 Mon Sep 17 00:00:00 2001 From: Steve Hamrick Date: Mon, 13 Jan 2020 13:03:34 -0700 Subject: [PATCH 3/4] Fix warnings --- docs/source/development/traffic_portal.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/development/traffic_portal.rst b/docs/source/development/traffic_portal.rst index 17f32b2ad8..0bb8633cd4 100644 --- a/docs/source/development/traffic_portal.rst +++ b/docs/source/development/traffic_portal.rst @@ -46,8 +46,10 @@ Installing The Traffic Portal Developer Environment #. Run ``bower install`` to install client-side dependencies into ``traffic_portal/app/bower_components``. Only needs to be done the first time unless ``traffic_portal/bower.json`` changes. #. Run ``grunt`` to package the application into ``traffic_portal/app/dist``, start a local HTTPS server (Express), and start a file watcher. #. Modify ``traffic_portal/conf/config.js``: + #. Valid SSL certificates and keys are needed for Traffic Portal to run. Generate these (e.g. using `this SuperUser answer `_) and update ``ssl``. #. Modify ``api.base_url`` to point to your Traffic Ops API endpoint. #. Modify ``files.static`` to be ``./app/dist/public``. #. Modify ``log.stream`` to be ``./server/log/access.log``. + #. Navigate to http(s)://localhost:[port|sslPort defined in ``traffic_portal/conf/config.js``] From ff506fec48252c72b74b8670e291c67b194249b3 Mon Sep 17 00:00:00 2001 From: Steve Hamrick Date: Mon, 13 Jan 2020 13:26:24 -0700 Subject: [PATCH 4/4] Use tabs --- docs/source/development/traffic_portal.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/development/traffic_portal.rst b/docs/source/development/traffic_portal.rst index 0bb8633cd4..1bf67b9c23 100644 --- a/docs/source/development/traffic_portal.rst +++ b/docs/source/development/traffic_portal.rst @@ -47,9 +47,9 @@ Installing The Traffic Portal Developer Environment #. Run ``grunt`` to package the application into ``traffic_portal/app/dist``, start a local HTTPS server (Express), and start a file watcher. #. Modify ``traffic_portal/conf/config.js``: - #. Valid SSL certificates and keys are needed for Traffic Portal to run. Generate these (e.g. using `this SuperUser answer `_) and update ``ssl``. - #. Modify ``api.base_url`` to point to your Traffic Ops API endpoint. - #. Modify ``files.static`` to be ``./app/dist/public``. - #. Modify ``log.stream`` to be ``./server/log/access.log``. + #. Valid SSL certificates and keys are needed for Traffic Portal to run. Generate these (e.g. using `this SuperUser answer `_) and update ``ssl``. + #. Modify ``api.base_url`` to point to your Traffic Ops API endpoint. + #. Modify ``files.static`` to be ``./app/dist/public``. + #. Modify ``log.stream`` to be ``./server/log/access.log``. #. Navigate to http(s)://localhost:[port|sslPort defined in ``traffic_portal/conf/config.js``]