From f93e60da94feba59c10fc7fa58ebceb059347860 Mon Sep 17 00:00:00 2001 From: Luis Cielak Date: Tue, 25 Sep 2018 14:51:34 -0400 Subject: [PATCH 1/7] Add financial verification content --- templates/help/index.html | 77 +++++++++++++++++++++++++++++++++++---- 1 file changed, 70 insertions(+), 7 deletions(-) diff --git a/templates/help/index.html b/templates/help/index.html index fa36a346..3be41133 100644 --- a/templates/help/index.html +++ b/templates/help/index.html @@ -8,11 +8,11 @@
    - {{ SidenavItem("Help Topic", + {{ SidenavItem("Getting Started", href="/help", active=g.matchesPath('/help'), subnav=[ - {"label":"Sub Topic", "href":"/help", "active": False}, + {"label":"Financial Verification", "href":"/help", "active": False}, {"label":"Sub Topic", "href":"/help", "active": False}, {"label":"Another Sub Topic", "href":"/help", "active": False}, ] @@ -40,15 +40,78 @@

    -
    JEDI Cloud Help Documentation
    - Help Topic +
    + JEDI Cloud Help Documentation +
    + + Getting Started +

    -

    So you see, since we're a small operation, we don't fall into the...uh...jurisdiction of the Empire. So you're part of the mining guild then? No, not actually. Our operation is small enough not to be noticed...which is advantageous for everybody since our customers are anxious to avoid attracting attention to themselves. Aren't you afraid the Empire's going to find out about this little operation and shut you down? That's always been a danger looming like a shadow over everything we've built here. But things have developed that will insure security. I've just made a deal that will keep the Empire out of here forever. We would be honored if you would join us. I had no choice. They arrived right before you did. I'm sorry. I'm sorry, too.

    -

    Now will you move along, little fella? We're got a lot of work to do. No! No, no! Stay and help you, I will. Find your friend, hmm? I'm not looking for a friend, I'm looking for a Jedi Master. Oohhh. Jedi Master. Yoda. You seek Yoda. You know him? Mmm. Take you to him, I will. Yes, yes. But now, we must eat. Come. Good food. Come. Come, come. Stay here and watch after the camp, Artoo.

    -

    Well done. Hold them in the security tower - and keep it quiet. Move. What do you think you're doing? We're getting out of here. I knew all along it had to be a mistake. Do you think that after what you did to Han we're going to trust you? I had no choice... What are you doing? Trust him, trust him! Oh, so we understand, don't we, Chewie? He had no choice. I'm just trying to help... We don't need any of your help. H-a-a-a... What? It sounds like Han. There's still a chance to save Han...I mean, at the East Platform... Chewie. I'm terribly sorry about all this. After all, he's only a Wookiee.

    +

    Financial Verification

    + +

    How to prepare for Financial Verification step?

    +

    Once your request is approved, the next step is to create a Task Order (T.O.) associated with the JEDI Cloud ID/IQ. Please contact a Contracting Officer (KO) or Contracting Officer Representative (COR) to help with this step.

    +

    This may also involve talking to your Financial Manager (FM) to secure funding.

    +

    Once the Task Order (T.O.) has been created, you will need to provide information related to the task order and funding in AT-AT. This step is referred to as “Financial Verification.”

    +

    We also recommend getting familiar with the JEDI Cloud CLIN structures so that you know which specific services are available under JEDI and categorized for contracting purposes. This will help you and the Contracting Officer create a Task Order.

    + +

    Why is this important?

    +

    This step allows AT-AT and the CCPO to track and report on cloud infrastructure spending across the Department., It also enables you and your team to see your cloud usage and verify your invoices with your budget.

    + +

    What to prepare for Financial Verification

    +

    You will need to have these details on hand before filling out the next step.

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Item you’ll need to provideFormat / ExampleExplanation
    Task Order Number associated with this request*Example:
    1234567899C0001    		 +

    Please include the original Task Order number (including the 000X at the end); this field is not requesting any modification numbers.

    +

    Please note that there may be a lag between the time you have created and approved the task order to the time it is searchable within the electronic.

    +

    A Contracting Officer will likely be the best source for this number.

    +
    Unique Item Identifiers (UII) related to your system(s) if you already have themExample:
    DI 0CVA5786950 OR UN1945326361234786950    		 +

    A Unique Investment Identifier is a unique code that helps the Department of Defense track and report on where and how digital assets are stored and where the budget comes from.

    +

    Not all applications have an existing UII number assigned.

    +

    This identifier can be found in SNaP-IT.

    +
    Program Element (PE) Number related to your requestExample:
    0203752A    		Program Element numbers helps the Department of Defense identify which offices' budgets are contributing towards this resource use.
    Program Treasury CodeExample:
    1200    		The Treasury Code (or Appropriations Code) is a four digit number that identifies resource types.
    Program BA CodeExample:
    02    		The Budget Activity Code (or BA Code) is a two digit number that is the category within each appropriation and fund account used to identify the purposes, projects, or types of activities financed by the appropriation fund.
    +
    +

    *AT-AT will search your Task Order number in available APIs and find other relevant details about your task order automatically. If we are unable to locate your Task Order, you will be asked to manually enter information such as total contract amount, CLIN amounts, and contracting officer information.

    +
From edddfd9a306c17cf179681f88147061593c37b3e Mon Sep 17 00:00:00 2001 From: Luis Cielak Date: Tue, 25 Sep 2018 16:28:50 -0400 Subject: [PATCH 2/7] Add help content --- static/img/at-at_faqs_content.svg | 1 + templates/help/index.html | 82 ++++++++++++++++++++++++++++--- 2 files changed, 77 insertions(+), 6 deletions(-) create mode 100644 static/img/at-at_faqs_content.svg diff --git a/static/img/at-at_faqs_content.svg b/static/img/at-at_faqs_content.svg new file mode 100644 index 00000000..c4c8d7e3 --- /dev/null +++ b/static/img/at-at_faqs_content.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/templates/help/index.html b/templates/help/index.html index 3be41133..f0ebf6be 100644 --- a/templates/help/index.html +++ b/templates/help/index.html @@ -12,9 +12,9 @@ href="/help", active=g.matchesPath('/help'), subnav=[ - {"label":"Financial Verification", "href":"/help", "active": False}, - {"label":"Sub Topic", "href":"/help", "active": False}, - {"label":"Another Sub Topic", "href":"/help", "active": False}, + {"label":"Financial Verification", "href":"#financial-verification", "active": False}, + {"label":"ID/IQ CLINs", "href":"#idiq-clins", "active": False}, + {"label":"JEDI Cloud Projects", "href":"#jedi-cloud-projects", "active": False}, ] )}} @@ -47,12 +47,18 @@ Getting Started + +
-

Financial Verification

+

Financial Verification

-

How to prepare for Financial Verification step?

+

How to prepare for Financial Verification step?

Once your request is approved, the next step is to create a Task Order (T.O.) associated with the JEDI Cloud ID/IQ. Please contact a Contracting Officer (KO) or Contracting Officer Representative (COR) to help with this step.

This may also involve talking to your Financial Manager (FM) to secure funding.

Once the Task Order (T.O.) has been created, you will need to provide information related to the task order and funding in AT-AT. This step is referred to as “Financial Verification.”

@@ -61,7 +67,7 @@

Why is this important?

This step allows AT-AT and the CCPO to track and report on cloud infrastructure spending across the Department., It also enables you and your team to see your cloud usage and verify your invoices with your budget.

-

What to prepare for Financial Verification

+

What to prepare for Financial Verification?

You will need to have these details on hand before filling out the next step.

@@ -112,6 +118,70 @@

*AT-AT will search your Task Order number in available APIs and find other relevant details about your task order automatically. If we are unable to locate your Task Order, you will be asked to manually enter information such as total contract amount, CLIN amounts, and contracting officer information.

+
+ +

ID/IQ CLINs

+ +

How are the JEDI ID/IQ CLINs structured?

+ +

We recommend sharing the following details with your contracting personnel to help accelerate the task order creation process.

+

The JEDI contract vehicle supports the following types of cloud infrastructure services.

+

Your contracting personnel will want to know which services above and contract line item numbers (CLINs) you are interested in procuring and what estimated dollar amounts to use associate. Use the JEDI Cloud Calculator to arrive at a price estimate for each of those.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
JEDI Contract Line Item Numbers (CLINs)Services supported
CLIN 0001 - Unclassified IaaS and PaaS Amount +

This CLIN covers infrastructure as a service (IaaS) features including the basic building blocks of networking features, computers (virtual or on dedicated hardware), and data storage space.

+

It also provides platform as a service (PaaS) features including resource procurement, capacity planning, software maintenance, patching, or any of the other undifferentiated heavy lifting involved in running your application.

+
CLIN 0003 - Unclassified Cloud Support PackageThis CLIN covers the basic customer service support package offered including _______
CLIN 1001 - Unclassified IaaS and PaaS Amount OPTION PERIOD 1 
CLIN 1003 - Unclassified Cloud Support Package OPTION PERIOD 1 
CLIN 2001 - Unclassified IaaS and PaaS Amount OPTION PERIOD 2 
CLIN 2003 - Unclassified Cloud Support Package OPTION PERIOD 2 
+
+ +
+ +

JEDI Cloud Projects

+ +

How are projects organized in the JEDI Cloud?

+ +

Project Structure for JEDI Cloud

+ +

Separate your workspace into projects and environments; this allows your team to manage user access to systems more securely and track expenditures for each project.

+

Here’s an example:
+ Project A has a development environment, production environment, and sandbox environment. The cloud resources in the development environment are grouped and accessed separately from the production environment and sandbox environment.

+ + AT-AT FAQs Content +
From 612a4a4f953601ed261e78b18f5d0aea8f38d54b Mon Sep 17 00:00:00 2001 From: Andrew Croce Date: Wed, 3 Oct 2018 13:57:39 -0400 Subject: [PATCH 3/7] helpdocs route takes a doc path and renders sub template list of helpdocs generated by files in `help/docs` --- atst/routes/__init__.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/atst/routes/__init__.py b/atst/routes/__init__.py index 03b18591..d586ef6e 100644 --- a/atst/routes/__init__.py +++ b/atst/routes/__init__.py @@ -3,6 +3,7 @@ from flask import Blueprint, render_template, g, redirect, session, url_for, req from flask import current_app as app import pendulum +import os from atst.domain.requests import Requests from atst.domain.users import Users @@ -30,8 +31,13 @@ def root(): @bp.route("/help") -def helpdocs(): - return render_template("help/index.html") +@bp.route("/help/") +def helpdocs(doc=None): + docs = [os.path.splitext(file)[0] for file in os.listdir("templates/help/docs")] + if doc: + return render_template("help/docs/{}.html".format(doc), docs=docs, doc=doc) + else: + return render_template("help/index.html", docs=docs, doc=doc) @bp.route("/home") From 73738495e12ce67feffc93bb4aa1fe31501e100b Mon Sep 17 00:00:00 2001 From: Andrew Croce Date: Wed, 3 Oct 2018 13:58:15 -0400 Subject: [PATCH 4/7] auto generate help nav make this a generic help index --- templates/help/index.html | 178 +++++--------------------------------- 1 file changed, 23 insertions(+), 155 deletions(-) diff --git a/templates/help/index.html b/templates/help/index.html index f0ebf6be..5b50226e 100644 --- a/templates/help/index.html +++ b/templates/help/index.html @@ -4,183 +4,51 @@ {% block title %}Help | JEDI Cloud{% endblock %} + {% block content %}
    - {{ SidenavItem("Getting Started", - href="/help", - active=g.matchesPath('/help'), - subnav=[ - {"label":"Financial Verification", "href":"#financial-verification", "active": False}, - {"label":"ID/IQ CLINs", "href":"#idiq-clins", "active": False}, - {"label":"JEDI Cloud Projects", "href":"#jedi-cloud-projects", "active": False}, - ] + + {{ SidenavItem("JEDI Cloud Help", + href = url_for("atst.helpdocs"), + active = not doc, + icon='help' )}} + {% for doc_item in docs %} + {% set active = doc and doc == doc_item %} - {{ SidenavItem("Another Help Topic", - href="/help", - active=False - )}} + {{ SidenavItem(doc_item | title, + href = url_for("atst.helpdocs", doc=doc_item), + active = active, + subnav = subnav or None + )}} + {% endfor %} - {{ SidenavItem("One More Help Topic", - href="/help", - active=False - )}}
- {{ Alert('Sample Content', - message='This is a sample help page intended to demonstrate the layout of a JEDI Cloud help documentation page.', - ) }}

-
- JEDI Cloud Help Documentation -
- - Getting Started - + {% if doc %} +
JEDI Cloud Help Documentation
+
{{ doc | title }}
+ {% else %} +
JEDI Cloud Help Documentation + {% endif %}

- -
-

Financial Verification

-

How to prepare for Financial Verification step?

-

Once your request is approved, the next step is to create a Task Order (T.O.) associated with the JEDI Cloud ID/IQ. Please contact a Contracting Officer (KO) or Contracting Officer Representative (COR) to help with this step.

-

This may also involve talking to your Financial Manager (FM) to secure funding.

-

Once the Task Order (T.O.) has been created, you will need to provide information related to the task order and funding in AT-AT. This step is referred to as “Financial Verification.”

-

We also recommend getting familiar with the JEDI Cloud CLIN structures so that you know which specific services are available under JEDI and categorized for contracting purposes. This will help you and the Contracting Officer create a Task Order.

- -

Why is this important?

-

This step allows AT-AT and the CCPO to track and report on cloud infrastructure spending across the Department., It also enables you and your team to see your cloud usage and verify your invoices with your budget.

- -

What to prepare for Financial Verification?

-

You will need to have these details on hand before filling out the next step.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Item you’ll need to provideFormat / ExampleExplanation
Task Order Number associated with this request*Example:
1234567899C0001		 -

Please include the original Task Order number (including the 000X at the end); this field is not requesting any modification numbers.

-

Please note that there may be a lag between the time you have created and approved the task order to the time it is searchable within the electronic.

-

A Contracting Officer will likely be the best source for this number.

-
Unique Item Identifiers (UII) related to your system(s) if you already have themExample:
DI 0CVA5786950 OR UN1945326361234786950		 -

A Unique Investment Identifier is a unique code that helps the Department of Defense track and report on where and how digital assets are stored and where the budget comes from.

-

Not all applications have an existing UII number assigned.

-

This identifier can be found in SNaP-IT.

-
Program Element (PE) Number related to your requestExample:
0203752A		Program Element numbers helps the Department of Defense identify which offices' budgets are contributing towards this resource use.
Program Treasury CodeExample:
1200		The Treasury Code (or Appropriations Code) is a four digit number that identifies resource types.
Program BA CodeExample:
02		The Budget Activity Code (or BA Code) is a two digit number that is the category within each appropriation and fund account used to identify the purposes, projects, or types of activities financed by the appropriation fund.
-
-

*AT-AT will search your Task Order number in available APIs and find other relevant details about your task order automatically. If we are unable to locate your Task Order, you will be asked to manually enter information such as total contract amount, CLIN amounts, and contracting officer information.

- -
- -

ID/IQ CLINs

- -

How are the JEDI ID/IQ CLINs structured?

- -

We recommend sharing the following details with your contracting personnel to help accelerate the task order creation process.

-

The JEDI contract vehicle supports the following types of cloud infrastructure services.

-

Your contracting personnel will want to know which services above and contract line item numbers (CLINs) you are interested in procuring and what estimated dollar amounts to use associate. Use the JEDI Cloud Calculator to arrive at a price estimate for each of those.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
JEDI Contract Line Item Numbers (CLINs)Services supported
CLIN 0001 - Unclassified IaaS and PaaS Amount -

This CLIN covers infrastructure as a service (IaaS) features including the basic building blocks of networking features, computers (virtual or on dedicated hardware), and data storage space.

-

It also provides platform as a service (PaaS) features including resource procurement, capacity planning, software maintenance, patching, or any of the other undifferentiated heavy lifting involved in running your application.

-
CLIN 0003 - Unclassified Cloud Support PackageThis CLIN covers the basic customer service support package offered including _______
CLIN 1001 - Unclassified IaaS and PaaS Amount OPTION PERIOD 1 
CLIN 1003 - Unclassified Cloud Support Package OPTION PERIOD 1 
CLIN 2001 - Unclassified IaaS and PaaS Amount OPTION PERIOD 2 
CLIN 2003 - Unclassified Cloud Support Package OPTION PERIOD 2 
-
- -
- -

JEDI Cloud Projects

- -

How are projects organized in the JEDI Cloud?

- -

Project Structure for JEDI Cloud

- -

Separate your workspace into projects and environments; this allows your team to manage user access to systems more securely and track expenditures for each project.

-

Here’s an example:
- Project A has a development environment, production environment, and sandbox environment. The cloud resources in the development environment are grouped and accessed separately from the production environment and sandbox environment.

- - AT-AT FAQs Content + {% block doc_content %} +

Welcome to the JEDI Cloud help documentation.

+ {% endblock %}
From 46bcda32d5d55c0adf9d475183857159b78e24ad Mon Sep 17 00:00:00 2001 From: Andrew Croce Date: Wed, 3 Oct 2018 13:58:32 -0400 Subject: [PATCH 5/7] jedi cloud help --- templates/footer.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/footer.html b/templates/footer.html index d9b30373..9b2c9d94 100644 --- a/templates/footer.html +++ b/templates/footer.html @@ -6,7 +6,7 @@ {{ Icon('help') }} - JEDI Help + JEDI Cloud Help
From acb4b0c7b90475c38e5f98c5a453417c439278d7 Mon Sep 17 00:00:00 2001 From: Andrew Croce Date: Wed, 3 Oct 2018 13:58:40 -0400 Subject: [PATCH 6/7] fixed table styles --- styles/elements/_tables.scss | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/styles/elements/_tables.scss b/styles/elements/_tables.scss index ee16d1c3..a16b93b3 100644 --- a/styles/elements/_tables.scss +++ b/styles/elements/_tables.scss @@ -96,3 +96,16 @@ } } } + +.fixed-table-wrapper { + width: 100%; + + table { + max-width: 100%; + table-layout:fixed; + + th, td { + white-space: normal; + } + } +} From a0c302ef433278dfab2737882019fec9513947e9 Mon Sep 17 00:00:00 2001 From: Andrew Croce Date: Wed, 3 Oct 2018 13:58:56 -0400 Subject: [PATCH 7/7] getting started help doc --- templates/help/docs/getting-started.html | 137 +++++++++++++++++++++++ 1 file changed, 137 insertions(+) create mode 100644 templates/help/docs/getting-started.html diff --git a/templates/help/docs/getting-started.html b/templates/help/docs/getting-started.html new file mode 100644 index 00000000..355e4974 --- /dev/null +++ b/templates/help/docs/getting-started.html @@ -0,0 +1,137 @@ +{% extends "help/index.html" %} + +{% set subnav = [ + {"label":"Financial Verification", "href":"#financial-verification"}, + {"label":"ID/IQ CLINs", "href":"#idiq-clins"}, + {"label":"JEDI Cloud Projects", "href":"#jedi-cloud-projects"}, +] %} + +{% block doc_content %} + +

Financial Verification

+ +

How to prepare for Financial Verification step?

+

Once your request is approved, the next step is to create a Task Order (T.O.) associated with the JEDI Cloud ID/IQ. Please contact a Contracting Officer (KO) or Contracting Officer Representative (COR) to help with this step.

+

This may also involve talking to your Financial Manager (FM) to secure funding.

+

Once the Task Order (T.O.) has been created, you will need to provide information related to the task order and funding in AT-AT. This step is referred to as “Financial Verification.”

+

We also recommend getting familiar with the JEDI Cloud CLIN structures so that you know which specific services are available under JEDI and categorized for contracting purposes. This will help you and the Contracting Officer create a Task Order.

+ +

Why is this important?

+

This step allows AT-AT and the CCPO to track and report on cloud infrastructure spending across the Department., It also enables you and your team to see your cloud usage and verify your invoices with your budget.

+ +

What to prepare for Financial Verification?

+

You will need to have these details on hand before filling out the next step.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Item you’ll need to provideFormat / ExampleExplanation
Task Order Number associated with this request*Example:
1234567899C0001		 +

Please include the original Task Order number (including the 000X at the end); this field is not requesting any modification numbers.

+

Please note that there may be a lag between the time you have created and approved the task order to the time it is searchable within the electronic.

+

A Contracting Officer will likely be the best source for this number.

+
Unique Item Identifiers (UII) related to your system(s) if you already have themExample:
DI 0CVA5786950 OR UN1945326361234786950		 +

A Unique Investment Identifier is a unique code that helps the Department of Defense track and report on where and how digital assets are stored and where the budget comes from.

+

Not all applications have an existing UII number assigned.

+

This identifier can be found in SNaP-IT.

+
Program Element (PE) Number related to your requestExample:
0203752A		Program Element numbers helps the Department of Defense identify which offices' budgets are contributing towards this resource use.
Program Treasury CodeExample:
1200		The Treasury Code (or Appropriations Code) is a four digit number that identifies resource types.
Program BA CodeExample:
02		The Budget Activity Code (or BA Code) is a two digit number that is the category within each appropriation and fund account used to identify the purposes, projects, or types of activities financed by the appropriation fund.
+
+

*AT-AT will search your Task Order number in available APIs and find other relevant details about your task order automatically. If we are unable to locate your Task Order, you will be asked to manually enter information such as total contract amount, CLIN amounts, and contracting officer information.

+ +
+ +

ID/IQ CLINs

+ +

How are the JEDI ID/IQ CLINs structured?

+ +

We recommend sharing the following details with your contracting personnel to help accelerate the task order creation process.

+

The JEDI contract vehicle supports the following types of cloud infrastructure services.

+

Your contracting personnel will want to know which services above and contract line item numbers (CLINs) you are interested in procuring and what estimated dollar amounts to use associate. Use the JEDI Cloud Calculator to arrive at a price estimate for each of those.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
JEDI Contract Line Item Numbers (CLINs)Services supported
CLIN 0001 - Unclassified IaaS and PaaS Amount +

This CLIN covers infrastructure as a service (IaaS) features including the basic building blocks of networking features, computers (virtual or on dedicated hardware), and data storage space.

+

It also provides platform as a service (PaaS) features including resource procurement, capacity planning, software maintenance, patching, or any of the other undifferentiated heavy lifting involved in running your application.

+
CLIN 0003 - Unclassified Cloud Support PackageThis CLIN covers the basic customer service support package offered including _______
CLIN 1001 - Unclassified IaaS and PaaS Amount OPTION PERIOD 1 
CLIN 1003 - Unclassified Cloud Support Package OPTION PERIOD 1 
CLIN 2001 - Unclassified IaaS and PaaS Amount OPTION PERIOD 2 
CLIN 2003 - Unclassified Cloud Support Package OPTION PERIOD 2 
+
+ +
+ +

JEDI Cloud Projects

+ +

How are projects organized in the JEDI Cloud?

+ +

Project Structure for JEDI Cloud

+ +

Separate your workspace into projects and environments; this allows your team to manage user access to systems more securely and track expenditures for each project.

+

Here’s an example:
+Project A has a development environment, production environment, and sandbox environment. The cloud resources in the development environment are grouped and accessed separately from the production environment and sandbox environment.

+ +AT-AT FAQs Content + +{% endblock %}