Changes between Initial Version and Version 1 of User Guide/Portal/Forum


Ignore:
Timestamp:
Mar 30, 2026, 5:54:08 PM (6 hours ago)
Author:
editor
Comment:

New: Community Forum sub-page

Legend:

Unmodified
Added
Removed
Modified
  • User Guide/Portal/Forum

    v1 v1  
     1[[Include(WikiToC)]]
     2= Community Forum =
     3
     4The COSMOS Community Forum is an integrated discussion platform where testbed users can ask questions, share experiment results, discuss techniques and best practices, report issues, and get help from both the user community and testbed administrators. It is built on Discourse, a modern forum platform, and is tightly integrated with the COSMOS Portal.
     5
     6----
     7
     8== Accessing the Forum ==
     9
     10The Community Forum is accessible from the portal sidebar under '''My Account''', directly below the Dashboard link. Clicking '''Community Forum''' opens the forum in a '''popup window''' (700 × 800 pixels) that you can resize and position alongside the main portal window.
     11
     12This popup design is intentional — it lets you keep the forum open for reference or discussion while simultaneously working with the scheduler, status pages, or other portal features in the main window.
     13
     14=== Single Sign-On ===
     15
     16The forum uses '''single sign-on (SSO)''' with the COSMOS Portal. This means:
     17
     18* If you are already logged into the portal, clicking Community Forum automatically signs you into the forum — no additional login is required.
     19* Your forum username matches your portal username.
     20* Your forum profile (name, email) is synchronized from your portal account.
     21* You do not need to create a separate forum account or remember a separate password.
     22
     23If you are not logged into the portal when you try to access the forum, you will be prompted to enter your portal credentials first.
     24
     25=== Notification Badge ===
     26
     27When other users post new topics or reply to discussions you are participating in, a small red '''notification badge''' appears next to the Community Forum link in the portal sidebar. The badge shows the number of unread notifications and updates automatically every 60 seconds.
     28
     29This lets you stay aware of forum activity without keeping the forum window open constantly.
     30
     31----
     32
     33== Forum Categories ==
     34
     35The forum is organized into topic categories to help you find relevant discussions:
     36
     37||= Category =||= Description =||
     38|| '''Announcements''' || Official testbed announcements from administrators — maintenance windows, new features, system changes. Check here for important updates. ||
     39|| '''Getting Started''' || Questions and answers for new users. If you are running your first experiment, learning the OMF tools, or setting up your SSH access, this is a good place to ask. ||
     40|| '''Experiments''' || Discussion about running experiments on the testbed — sharing techniques, reporting results, coordinating multi-user setups, and troubleshooting experiment-specific issues. ||
     41|| '''SDR & RF''' || Topics related to software-defined radio and RF equipment — USRP configuration, GNU Radio pipelines, antenna setups, spectrum analysis, and RF calibration. ||
     42|| '''Troubleshooting''' || Help with problems and debugging — nodes not booting, imaging failures, network connectivity issues, software compatibility, and other technical problems. ||
     43|| '''Feature Requests''' || Suggestions for improvements to the testbed, portal, or supporting tools. The testbed team monitors this category for community input. ||
     44
     45----
     46
     47== How to Use the Forum ==
     48
     49=== Reading Topics ===
     50
     51Browse topics by clicking a category name on the forum home page. Topics are listed with the most recently active at the top. Each topic shows:
     52
     53* The title and a preview of the first post
     54* The author and when it was created
     55* The number of replies and views
     56* The last person to reply and when
     57
     58Click any topic to read the full discussion thread.
     59
     60=== Posting a New Topic ===
     61
     621. Click '''New Topic''' (or the + button) at the top of the forum
     632. Select the appropriate category from the dropdown
     643. Enter a descriptive title that summarizes your question or topic
     654. Write your post in the editor. The forum supports rich formatting:
     66   * '''Markdown''' for text formatting (bold, italic, headers, lists)
     67   * '''Code blocks''' — wrap code in triple backticks for syntax highlighting
     68   * '''File attachments''' — drag and drop images or files into the editor
     69   * '''Mentions''' — type `@username` to notify a specific user
     705. Click '''Create Topic''' to publish
     71
     72=== Replying to Topics ===
     73
     74Click the '''Reply''' button at the bottom of a topic to add your response. You can also reply to a specific post within a thread by clicking the reply arrow on that individual post — this creates a threaded reply that shows the context.
     75
     76=== Best Practices for Getting Help ===
     77
     78When posting a question or reporting a problem:
     79
     80* '''Include your setup''' — which testbed domain, which nodes, what image you loaded
     81* '''Show your commands''' — paste the exact `omf` commands you ran and their output
     82* '''Describe expected vs. actual behavior''' — what you expected to happen and what actually happened
     83* '''Include error messages''' — copy and paste the full error, not just a summary
     84* '''Use code blocks''' — wrap terminal output and code in triple backticks for readability
     85
     86Good example:
     87{{{
     88I'm running on sb3.orbit-lab.org and loaded baseline-uhd.ndz on node1-1 and node1-2.
     89After imaging, node1-2 won't power on:
     90
     91```
     92$ omf tell on -t node1-2
     93node1-2.sb3.orbit-lab.org: FAILED - timeout waiting for power on
     94```
     95
     96node1-1 works fine. I tried `omf tell reset -t node1-2` but got the same result.
     97Any suggestions?
     98}}}
     99
     100----
     101
     102== Forum Etiquette ==
     103
     104* '''Search before posting''' — your question may already have been answered. Use the search bar at the top of the forum.
     105* '''Use meaningful titles''' — "Help!" is not useful; "omf load timeout on sb1.cosmos after 15 minutes" helps everyone.
     106* '''Stay on topic''' — post in the appropriate category.
     107* '''Be respectful''' — the forum is a professional space shared by researchers, students, and engineers from around the world.
     108* '''Mark solutions''' — if someone's reply solves your problem, mark it as the solution so others can find the answer quickly.
     109
     110----
     111
     112== Privacy and Access ==
     113
     114The COSMOS Community Forum is '''internal only''' — it is not publicly accessible on the Internet and is not indexed by search engines. Only users with valid COSMOS/ORBIT portal accounts can view or post content. This means you can safely discuss experiment details, share intermediate results, and ask candid questions about testbed usage without concern about public exposure.
     115
     116Self-registration on the forum is disabled. Account creation is handled exclusively through the COSMOS Portal single sign-on mechanism.