Rebranding to new look

blackboard · Sep 3, 2024 · b474121 · b474121
1 parent 55a98cf
commit b474121
Show file tree

Hide file tree

Showing 252 changed files with 4,664 additions and 9,688 deletions.
diff --git a/README.md b/README.md
@@ -6,22 +6,19 @@ With this move to Docusaurus we are adding full site search capability and looki
 
 ## IMPORTANT:
 
-When creating new documentation using MD, please copy and paste the layout within `/docs/templates/example.md` since that includes two additional trackers that will show information or add the following tags to the top and bottom of your page respectively:
+When creating new documentation using MD, please add the following information to the top of the document:
 
-```html
+```md
 ---
-Metadata
+title:
+id:
+categories:
+published: "YYYY-MM-DD"
+edited: "YYYY-MM-DD"
+author:
 ---
-
-<VersioningTracker frontMatter="{frontMatter}" />
-
-Your content goes here
-
-<AuthorBox frontMatter="{frontMatter}" />
 ```
 
-Please also make sure to fill out the metadata at the top of the page with the appropriate information
-
 ## Getting Started
 
 :warning: Do not push, pull, fetch, or otherwise "manage" the gh-pages branch. This branch is auto maintained by main PRs and merge actions.

diff --git a/...rest-apis/ally/about-api-documentation.md → docs/ally/about-api-documentation.md b/...rest-apis/ally/about-api-documentation.md → docs/ally/about-api-documentation.md
@@ -7,13 +7,11 @@ edited: ""
 author: Scott Hurrey
 ---
 
-<VersioningTracker frontMatter={frontMatter}/>
-
 # How to use the Ally as a Service API Document to Test API
 
 The API documentation for Ally as a Service allows a developer to test the API real-time inline on the page. It is a quick and easy way to not only get high-level information about the API itself, but also see how it works. You can upload a file, check the status of processing, and retrieve the report when finished. Doing so and then testing your application with the same file is a quick, easy, and powerful way to validate your work.
 
-To do this, you will need your client ID and your secret. See the [Getting Started Guide](/docs/rest-apis/ally/getting-started.md) for information on how to request your credentials. At the top of the page you will see two text boxes, one for each of these values. Simply plug them in and you are all ready to.
+To do this, you will need your client ID and your secret. See the [Getting Started Guide](/docs/ally/getting-started.md) for information on how to request your credentials. At the top of the page you will see two text boxes, one for each of these values. Simply plug them in and you are all ready to.
 
 At the bottom of the documentation for the `Upload a File to Ally` endpoint, there is a **Try it now** section, where you can select a file and click submit to upload that file to be processed.
 
@@ -26,5 +24,3 @@ Finally, at the bottom of the documentation for the `Retrieve the feedback for a
 For a walkthrough, check out this video:
 
 <iframe class="embed-video" src="https://www.youtube.com/embed/mr72Q3eyCwc" frameborder="0" allow="accelerometer; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
-
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/rest-apis/ally/auth.md → docs/ally/auth.md b/docs/rest-apis/ally/auth.md → docs/ally/auth.md
@@ -7,8 +7,6 @@ edited: ""
 author: Scott Hurrey
 ---
 
-<VersioningTracker frontMatter={frontMatter}/>
-
 Blackboard Ally as a Service relies on JSON web tokens (JWT) to authenticate and authorize incoming REST API calls. You can read more about the JWT standard [here](https:////tools.ietf.org/html/rfc7519).
 
 The JSON web token must be signed with HMAC. HMAC allows the JWT to be signed with a shared secret. The data can be trusted because it is digitally signed with mutually known credentials.
@@ -167,5 +165,3 @@ thus, there are a ton of resources available for developers interested in JWT be
 
 - [JWT.io](https://jwt.io/): This site is dedicated to assisting developers trying to build JWT-enabled applications. There is a debugger that allows you to manually input your secret and your header and payload and generate an assertion. There is also an extensive list of available libraries in multiple languages that handle the bulk of the JWT creation.
 - [RFC 7519](https://tools.ietf.org/html/rfc7519): This is the actual standard specification document.
-
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/rest-apis/ally/check-status.md → docs/ally/check-status.md b/docs/rest-apis/ally/check-status.md → docs/ally/check-status.md
@@ -7,8 +7,6 @@ edited: ""
 author: Scott Hurrey
 ---
 
-<VersioningTracker frontMatter={frontMatter}/>
-
 Ally processes files asynchronously. We aim to process files in near-realtime, but some delays might be present. This endpoint can be used to poll for status updates.
 
 ### Endpoint
@@ -64,5 +62,3 @@ curl \
   -H "Authorization: Bearer myJwtToken" \
   https://prod.ally.ac/api/v2/clients/:clientId/content/:contentHash/status
 ```
-
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/rest-apis/ally/feedback-definitions.md → docs/ally/feedback-definitions.md b/docs/rest-apis/ally/feedback-definitions.md → docs/ally/feedback-definitions.md
@@ -7,8 +7,6 @@ edited: ""
 author: Scott Hurrey
 ---
 
-<VersioningTracker frontMatter={frontMatter}/>
-
 # Feedback parameter definitions
 
 Here are the feedback parameters returned when the feedback endpoint is called. The full and meta columns defines which fields are included based on the feedback query parameter. If it is set to true, you get the full response, and the full column will have a <i class="material-icons">check</i>. If it is set to false or omitted, you receive just the meta data, and Meta column will have an <i class="material-icons">check</i>
@@ -100,5 +98,3 @@ Here are the feedback parameters returned when the feedback endpoint is called.
 | metadata.libraryReference                                   | **Deprecated** Not used. This will always be null and will be removed in a future release      | <i class="material-icons">check</i> | <i class="material-icons">check</i> |
 
 For more information about the Ally accessibility tests, visit the [Accessibility Checklist](https://help.blackboard.com/ally/Ally_for_LMS/Administrator/Institution_Report/Accessibility_Checklist) page on help.blackboard.com.
-
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/rest-apis/ally/get-batched-feedback.md → docs/ally/get-batched-feedback.md b/docs/rest-apis/ally/get-batched-feedback.md → docs/ally/get-batched-feedback.md
@@ -7,8 +7,6 @@ edited: ""
 author: Simon Gaeremynck
 ---
 
-<VersioningTracker frontMatter={frontMatter}/>
-
 The batch endpoint allows you to retrieve content for more than one content hash
 
 ## Endpoint
@@ -89,5 +87,3 @@ curl \
   -d '{"references": [{"hash": "a1b2c3d..."},{"hash": "QWxseSs..."},{"hash": "e1f2123..."}]}' \
   https://prod.ally.ac/api/v2/clients/:clientId/content/bash
 ```
-
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/rest-apis/ally/get-feedback.md → docs/ally/get-feedback.md b/docs/rest-apis/ally/get-feedback.md → docs/ally/get-feedback.md
@@ -7,8 +7,6 @@ edited: ""
 author: Scott Hurrey
 ---
 
-<VersioningTracker frontMatter={frontMatter}/>
-
 Once the file is processed, the feedback can be retrieved
 
 ## Endpoint
@@ -37,7 +35,7 @@ GET /api/v2/clients/:clientId/content/:contentHash
 
 ## Expected response
 
-For more information on the contents of this JSON, visit the [feedback definitions page](/docs/rest-apis/ally/feedback-definitions.md).
+For more information on the contents of this JSON, visit the [feedback definitions page](/docs/ally/feedback-definitions.md).
 
 **feedback=true**
 
@@ -204,5 +202,3 @@ curl \
   -H "Authorization: Bearer myJwtToken" \
   https://prod.ally.ac/api/v2/clients/:clientId/content/:contentHash
 ```
-
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/rest-apis/ally/getting-started.md → docs/ally/getting-started.md b/docs/rest-apis/ally/getting-started.md → docs/ally/getting-started.md
@@ -8,8 +8,6 @@ author: Scott Hurrey
 sidebar_position: 1
 ---
 
-<VersioningTracker frontMatter={frontMatter}/>
-
 Ally as a Service provides separatly licensed, stand-alone API access to allow an application to process files for accessibility. Many of you are using this power in your LMS to help instructors improve the accessibility of their content, and to give students, regardless of ability, access to the content that meets their needs and learning style the best.
 
 To get started, the first thing you need is a client ID, key, and secret. At this time, the best way to obtain this information is to engage your Account Executive to discuss pricing and request credentials. As the API continues to grow, this process may change, so be sure to check back here often.
@@ -20,7 +18,7 @@ Click here to learn more about [authorization and authentication](auth.md) for A
 
 There are a number of ways to test out the API. The easiest is to use the Ally API. You can enter your client ID and your secret, and then interact with the available API directly from the documentation.
 
-Click here to learn more about [using the API documentation](/docs/rest-apis/ally/about-api-documentation.md) in this way.
+Click here to learn more about [using the API documentation](/docs/ally/about-api-documentation.md) in this way.
 
 Here are the operations currently available in the API (each page has a sample cURL command at the bottom):
 
@@ -37,5 +35,3 @@ As we create tutorials and sample code, we will list them here.
 - [Ally as a Service API documentation](https://ally.ac/api/) - Includes sample cURL Commands
 - [Postman Collection](https://github.com/blackboard/BBDN-AaaS-Postman)
 - [Python](https://github.com/blackboard/BBDN-AaaS-Python)
-
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/rest-apis/ally/ui-integration.md → docs/ally/ui-integration.md b/docs/rest-apis/ally/ui-integration.md → docs/ally/ui-integration.md
@@ -7,8 +7,6 @@ edited: ""
 author: Simon Gaeremynck
 ---
 
-<VersioningTracker frontMatter={frontMatter}/>
-
 The UI API is a specification for HTML attributes that can be used to introduce consistent patterns of Ally functionality.
 
 ## Set-up
@@ -148,5 +146,3 @@ The following example contains two links. The first link is a download link your
     height="20" />
 </a>
 ```
-
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/rest-apis/ally/uploading-files.md → docs/ally/uploading-files.md b/docs/rest-apis/ally/uploading-files.md → docs/ally/uploading-files.md
@@ -7,8 +7,6 @@ edited: ""
 author: Scott Hurrey
 ---
 
-<VersioningTracker frontMatter={frontMatter}/>
-
 Start the process by uploading the file you would like to get feedback for. This is a multipart POST request. The response will contain the statusUrl that you can poll to check whether the file has been processed. If the file was processed previously, a resourceUrl will be provided through which you can fetch the feedback information immediately.
 
 ## Supported content types
@@ -127,5 +125,3 @@ This section contains answers to many of the common questions we field as develo
   - No, see next answer.
 - **Q: The meta data contains a “name”, “description” and other parameters. But these are not reflections of arguments in the initial POST. Is this just an indication that there’s a richer set of arguments for the submission phase?**
   - These parameters are artifacts from our LMS API. They will be removed shortly as they carry no function in a standalone function.
-
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/archive/b2/getting-started/api-documentation.md b/docs/archive/b2/getting-started/api-documentation.md
@@ -7,7 +7,6 @@ author: Scott Hurrey
 status: deprecated
 displayed_sidebar: documentationSidebar
 ---
-<VersioningTracker frontMatter={frontMatter}/>
 
 :warning: This document is deprecated!
 
@@ -88,4 +87,3 @@ database object inBlackboard Learn. The following information is not included:
 | Q4 2016     | [View API](https://library.blackboard.com/d/%3F78e2d337-a6b3-4483-98b0-ac2a491f1135)           | [View Taglibs](https://library.blackboard.com/d/%3F2af249ea-1073-4c77-97ea-90d14c80f2a5)           | [View Schema](https://library.blackboard.com/d/%3Fb292c30f-4e6d-4211-8a2c-f28a12bfd3fd)           |
 | Q2 2016     | [View API](https://library.blackboard.com/ref/16ce28ed-bbca-4c63-8a85-8427e135a710/index.htm)  | [View Taglibs](https://library.blackboard.com/ref/ece618d2-a7c2-488d-a816-c5a92ff09cd6/index.htm)  | [View Schema](https://library.blackboard.com/ref/a8859dd1-b28a-40e0-9aa4-763cf0d65e04/index.htm)  |
 | Q4 2015     | [View API](https://library.blackboard.com/ref/564b246f-4b44-4e85-881e-3731b8a3fe45/index.html) | [View Taglibs](https://library.blackboard.com/ref/8ff5b468-6512-46a3-bc0b-2309de00b802/index.html) | [View Schema](https://library.blackboard.com/ref/589ebf8f-b007-425d-91ec-27d53e40fde4/index.html) |
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/archive/b2/getting-started/api-overview.md b/docs/archive/b2/getting-started/api-overview.md
@@ -7,7 +7,6 @@ author: Scott Hurrey
 status: deprecated
 displayed_sidebar: documentationSidebar
 ---
-<VersioningTracker frontMatter={frontMatter}/>
 
 :warning: This document is deprecated!
 
@@ -150,4 +149,3 @@ possible with the Snapshot enterprise data integration tool.
 
 Various classes to support functions such as byte->kilobyte conversion and
 localized number representation.
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/archive/b2/getting-started/dev-life-cycle.md b/docs/archive/b2/getting-started/dev-life-cycle.md
@@ -7,7 +7,6 @@ author: Scott Hurrey
 status: deprecated
 displayed_sidebar: documentationSidebar
 ---
-<VersioningTracker frontMatter={frontMatter}/>
 
 :warning: This document is deprecated!
 
@@ -345,4 +344,3 @@ Block which may be lost should you uninstall a previous version to install the
 new version.
 
 Always thoroughly test any changes you make to your Building Blocks.
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/archive/b2/getting-started/faq.md b/docs/archive/b2/getting-started/faq.md
@@ -7,7 +7,6 @@ author: Scott Hurrey
 status: deprecated
 displayed_sidebar: documentationSidebar
 ---
-<VersioningTracker frontMatter={frontMatter}/>
 
 :warning: This document is deprecated!
 
@@ -87,4 +86,3 @@ issue:
 2. If the vendor instructs you to submit a help ticket with Blackboard, please work with your Blackboard Administrator to do so on Behind the Blackboard
 3. Our Support team will attempt to collaborate with the vendor to resolve the issue
 4. Issues that cannot be resolved are escalated as appropriate via our support process
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/archive/b2/getting-started/first-steps.md b/docs/archive/b2/getting-started/first-steps.md
@@ -7,7 +7,6 @@ author: Scott Hurrey
 status: deprecated
 displayed_sidebar: documentationSidebar
 ---
-<VersioningTracker frontMatter={frontMatter}/>
 
 :warning: This document is deprecated!
 
@@ -68,4 +67,3 @@ Block development:
 - [Building Block Development Life Cycle](./dev-life-cycle.md)
 - [Enabling Debugging](../resources/enabling-remote-debugging.md)
 - [First Project: Gradle, Git, and basic-b2-template](../resources/first-project-using-gradle-and-git.md)
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/archive/b2/getting-started/intro.md b/docs/archive/b2/getting-started/intro.md
@@ -7,7 +7,6 @@ author: Scott Hurrey
 status: deprecated
 displayed_sidebar: documentationSidebar
 ---
-<VersioningTracker frontMatter={frontMatter}/>
 
 :warning: This document is deprecated!
 
@@ -66,4 +65,3 @@ administrator) or contact your sales representative.
 If you are interested in becoming a Blackboard partner visit the [Blackboard Partnerships](https://www.blackboard.com/partnership/index.aspx)™
 program site. Partnering with Blackboard provides access to design guidance
 and support among other benefits.
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/archive/b2/getting-started/rosetta-stone.md b/docs/archive/b2/getting-started/rosetta-stone.md
@@ -7,7 +7,6 @@ authors: Mark Kauffman
 status: deprecated
 displayed_sidebar: documentationSidebar
 ---
-<VersioningTracker frontMatter={frontMatter}/>
 
 :warning: This document is deprecated!
 
@@ -73,4 +72,3 @@ You want to know this because this page is infrequently updated. Just log in to
   - [9.1 Q4 2015 Cumulative Update 2](https://blackboard.secure.force.com/btbb_articleview?id=kA0390000004fs7) (Build: 9.1.201510.1175205)
   - [9.1 Q4 2015 Cumulative Update 1](https://blackboard.secure.force.com/btbb_articleview?id=kA0390000000Djn) (LRNSI-21344)
   - [9.1 Q4 2015](https://blackboard.secure.force.com/btbb_articleview?id=kA47000000002kA) (Build: 9.1.201510.1171621)
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/archive/b2/getting-started/starter-b2.md b/docs/archive/b2/getting-started/starter-b2.md
@@ -7,7 +7,6 @@ author: Kelley MacEwen
 status: deprecated
 displayed_sidebar: documentationSidebar
 ---
-<VersioningTracker frontMatter={frontMatter}/>
 
 :warning: This document is deprecated!
 
@@ -89,4 +88,3 @@ commented out by default since the task is new to Ant 1.7 and will not work
 unless you have that version of Ant or newer. If its use is necessary for you,
 make sure you have Ant 1.7, uncomment out the task, and then update the
 setting of deploy.url to use warfile.url in place of warfile.
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/archive/b2/resources/enabling-remote-debugging.md b/docs/archive/b2/resources/enabling-remote-debugging.md
@@ -7,7 +7,6 @@ author: Scott Hurrey
 status: deprecated
 displayed_sidebar: documentationSidebar
 ---
-<VersioningTracker frontMatter={frontMatter}/>
 
 :warning: This document is deprecated!
 
@@ -55,4 +54,3 @@ button “Debug” and Eclipse will connect with the Learn instance of Tomcat
 (Learn must be running). Now when you put the breakpoints inside the Eclipse
 project you may debug as you would normally with a regular project only now it
 is remote code running in the Learn Tomcat container.
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/archive/b2/resources/first-project-using-gradle-and-git.md b/docs/archive/b2/resources/first-project-using-gradle-and-git.md
@@ -6,7 +6,6 @@ id: archive-b2-resources-first_project_gradle
 author: Scott Hurrey
 displayed_sidebar: documentationSidebar
 ---
-<VersioningTracker frontMatter={frontMatter}/>
 
 :warning: This document is deprecated!
 
@@ -292,4 +291,3 @@ While average build-times may not significantly decrease, the significant time
 savings resulting from improved general project management and from the
 deployment feature of the Learn/Gradle dev environment adds up quickly when
 compared to a manual deploy cycle.
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/archive/b2/resources/java11-faq.md b/docs/archive/b2/resources/java11-faq.md
@@ -6,7 +6,6 @@ id: archive-b2-resources-java_11
 author: Scott Hurrey
 displayed_sidebar: documentationSidebar
 ---
-<VersioningTracker frontMatter={frontMatter}/>
 
 :warning: This document is deprecated!
 
@@ -54,4 +53,3 @@ As with prior Java version changes, it is generally expected that Building Block
 8. **How can I avoid having to do frequent testing and recompiling of Building Blocks?**
 
    - As noted above, including copies of dependent libraries in the Building Block rather than referencing them in the Learn application will help. To avoid the overhead of maintaining Building Blocks through these frequent library changes, we encourage you to also consider our ever-expanding support for LTI and REST APIs to determine when it would appropriate for you to transition your solution to these integration frameworks that aren’t impacted by library changes. The LTI/REST framework has the added benefit of being supported across all Learn deployments and UX options enabling your integration to also be Ultra ready.
-<AuthorBox frontMatter={frontMatter}/>
diff --git a/docs/archive/b2/resources/prepare-for-java11.md b/docs/archive/b2/resources/prepare-for-java11.md
@@ -6,7 +6,6 @@ id: archive-b2-resources-prepare_for_java_11
 author: Scott Hurrey
 displayed_sidebar: documentationSidebar
 ---
-<VersioningTracker frontMatter={frontMatter}/>
 
 :warning: This document is deprecated!
 
@@ -38,7 +37,7 @@ Deployed in February 2020.
 
    When collecting updated Building Blocks, make sure you have the latest version of the B2 from the provider (vendor, open source, or internal). Check vendor websites or contact vendors’ support and get the latest versions of B2s from them. Confirm that the updates have been tested to be Java 11 compatible and validate in your test or stage environment. For open source Building Blocks you use, check community sources such as [OSCELOT](https://github.com/oscelot) to see if updates are available. If you have B2s created by Blackboard Consulting and supported under an ICM contract, contact Blackboard Product Support for the latest version that is Java 11 compatible.
 
-3. **Transition integrations to different integration types**. Some solution providers have transitioned their integrations to other methods, such as leveraging the [Learning Tools Interoperability (LTI) standard](https://imsglobal.org/lti) or [REST APIs](/docs/rest-apis/learn/getting-started/first-steps.md) instead of Building Block APIs. In some cases, they may have completely different B2 integrations than the one you’re using. Working with these vendors, determine whether this is appropriate for you. Examples of these integrations requiring transition include Lynda.com and Turning Technologies.
+3. **Transition integrations to different integration types**. Some solution providers have transitioned their integrations to other methods, such as leveraging the [Learning Tools Interoperability (LTI) standard](https://imsglobal.org/lti) or [REST APIs](/docs/blackboard/rest-apis/getting-started/first-steps.md) instead of Building Block APIs. In some cases, they may have completely different B2 integrations than the one you’re using. Working with these vendors, determine whether this is appropriate for you. Examples of these integrations requiring transition include Lynda.com and Turning Technologies.
 
 4. **Test and update in-house Building Blocks**. If you have B2s created at your institution, you should confirm their functionality in test/stage and prepare to update them. Guidance about updating Building Blocks can be found [here](preparing-for-saas-and-new-learn-versions.md). We’ve created an automated tool to assist with identifying potential library incompatibilities. While this tool doesn’t necessarily inform you of the functional behavior of the Building Block with Java 11, it provides guidance around library incompatibilities that could lead to a non-functional B2. See the section about the Building Block Scan Tool in the Resources section below.
 
@@ -70,4 +69,3 @@ Deployed in February 2020.
 
   - [Preparing a Building Block for a newer version of Learn and ensuring it works with Learn SaaS](preparing-for-saas-and-new-learn-versions.md)
   - [B2 development frequently asked questions](../getting-started/faq.md)
-<AuthorBox frontMatter={frontMatter}/>