Knowledge Base v2
Infrastructure Integration Roadmap Task
Task Type(s): Support
Start by phase: Integration
Complete by phase: Operations
RP role(s): Documentation and knowledge base contact(s)
Summary
The purpose of this task is to ensure that RPs have provided all of the knowledge base elements that are needed to fully represent their resources to the ACCESS team and the general user community. Components of the information provided will be represented on the ACCESS MATCH Portal (AMP).
Required Actions
Resource Providers must complete the following to fulfill this task:
Confirm your resource summary is in CiDeR - Ensure a summary paragraph describing your Resource Provider offering(s) is available in CiDeR. This will be displayed on AMP via the CiDeR API.
Provide user documentation - Full User Guide(s) should reside at and be maintained by the RP on their own site, or in the ACCESS Knowledge Base (Atlassian Confluence). See Adding Resource Documentation to the ACCESS Knowledge Base below for instructions on requesting Confluence edit access.
Review how to share news and events - Familiarize yourself with the process for sharing news items and events with the ACCESS community via the ACCESS Support Portal. See News Items and Events below.
Prerequisite tasks
Support Information
For assistance with this task see the Support Information section in the Integration Roadmap Description.
Detailed Instructions
Adding Resource Documentation to the ACCESS Knowledge Base
Resource Providers can add documentation about their resource to the ACCESS Knowledge Base hosted on Atlassian Confluence. This may include a dedicated section for your resource or a link to your existing RP user documentation.
To request edit access:
Submit a ticket using the Internal ACCESS and Resource Provider Request form.
Under Request Title, enter: “Confluence edit access request - [your resource name]”
Under ACCESS Operational Support Issues, select Support: OnDemand, Pegasus, Knowledge Base, Affinity Groups, Events, Announcements, Ask.CI, etc.
In the description, specify:
The name of your resource
The contact(s) who need edit access (include their ACCESS usernames)
Whether you plan to add a new documentation section or link to existing RP documentation
Complete the required fields and submit.
ACCESS support staff will review your request and grant the appropriate Confluence permissions.
News Items
Submit news items via the ACCESS Support Portal. You will see a box on the right side that says “Posting News, Do you have news you would like to share with the ACCESS community?” which will take you to a page to submit your news item. You can post directly to your Affinity Group. You must be signed in to ACCESS to submit.
Events
Submit events via the ACCESS Support Portal. This link shows all events in a calendar format. You will see a box on the right side that says “Posting Events, Do you have events or training you would like to share with the ACCESS community?” which will take you to a page to submit your event. Events can also be shared with your Affinity Group. You must be signed in to ACCESS to submit.
Creation of an Affinity Group (Optional)
You will need to log in first to make changes to your group. Your Affinity Group will be automatically created and populated, but you should ensure you have the proper coordinators and profile that best suits your needs. If you do not see your Affinity Group, submit a request via the link at the top of the page or submit a ticket.
An Affinity Group is made for each RP. Additional groups can be requested if you would like to form one that targets a specific set of community members who have a common, shared interest in a computational issue, scientific or engineering research endeavor, diversity and inclusion effort, or any other connection point. Each Affinity Group will have access to Slack channels, forums, news, outage alerts, events, and training materials.
Knowledge Base Service Integrations (Optional)
ACCESS projects, integrated resources, and central service operators may also request integration with the following Knowledge Base services:
ACCESS Resource Advisor (ARA) - https://ara.access-ci.org/
Software Documentation Service (SDS) - https://sds.access-ci.org/
ACCESS Chatbot (QA Tool) - https://support.access-ci.org/tools/access-qa-tool
To request integration of any of these services, please submit a ticket using the ACCESS Support Portal form:
On the ticket form, please:
Under Request Title of the form, fill in: “SDS / ARA / QA Tool integration - [your project or resource name]”
Under ACCESS Operational Support Issues, select Support: OnDemand, Pegasus, Knowledge Base, Affinity Groups, Events, Announcements, Ask.CI, etc.
Complete the required fields and submit.
ACCESS support staff will review your request and follow up directly.
About These Services
ACCESS Resource Advisor (ARA) - A web-based interactive tool that helps researchers select the most suitable ACCESS resource by asking questions about research domain, required software, hardware needs, and previous experience. It produces tailored recommendations across ACCESS resources.
Software Documentation Service (SDS) - Helps ACCESS users discover which resources are pre-configured with particular software, such as Jupyter Notebooks or Open OnDemand.
ACCESS Chatbot (QA Tool) - Provides automated, AI-driven conversational support to help users navigate ACCESS documentation and services.