FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Updating Progress on DOC-STRUCT-004 by AnnaZiegler · Pull Request #8 · ControlSystemStudio/phoebus-codeathon · GitHub

  1. ControlSystemStudio
  2. phoebus-codeathon

Repository navigation

Updating Progress on DOC-STRUCT-004 #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AnnaZiegler wants to merge 4 commits into
base: master
Choose a base branch
Could not load branches
Branch not found: {{ refName }}

Are you sure you want to change the base?

Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
from
Conversation 0 Commits 4 Checks 0 Files changed
Open

Updating Progress on DOC-STRUCT-004 #8

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7420a35
Added Missing Information - DOC-STRUCT-004
AnnaZiegler Feb 26, 2026
c817531
Progress Expand Collaboration Section - DOC-STRUCT-004
AnnaZiegler Feb 27, 2026
7b3d20f
Finished Expand Collaboration Section
AnnaZiegler Mar 5, 2026
be56ea2
Merge branch 'master' into master
AnnaZiegler Mar 5, 2026
File filter

Filter by extension

Filter by extension .md  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
34 changes: 18 additions & 16 deletions documentation-tasks/README.md
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -180,20 +180,24 @@ Phoebus.org serves as the main landing page for the Phoebus ecosystem but has ou
- Audit all external links (GitHub repos, documentation sites, downloads) :white_check_mark:
- Update broken or outdated links :white_check_mark:
- Ensure links point to correct ReadTheDocs documentation :white_check_mark:
- Add links to all ecosystem services (Alarm Services, Archiver Appliance, ChannelFinder, Olog, Save & Restore) :question: (Might need to be updated after the Documentation was updated. Currently all links work as intended.)
- Fix links to community resources (Matrix chat, ~~mailing lists~~, GitHub Discussions) :white_check_mark:
- [ ] **Add Missing Information**:
- Complete service descriptions for all middleware services
- Add "Getting Started" quickstart guide
- Include architecture overview diagram showing how services interact
- List key features and capabilities
- [ ] **Expand Collaboration Section**:
- Highlight community contribution opportunities
- Add "How to Contribute" section with clear paths for different skill levels
- Showcase community contributors and facilities using Phoebus
- Add community calendar (codeathons, meetings, webinars)
- Link to CONTRIBUTING.md in main repository
- Include community communication channels (Matrix, GitHub, mailing lists)
- Add links to all ecosystem services (Alarm Services, Archiver Appliance, ChannelFinder, Olog, Save & Restore) :question: (Maybe has to be updated after the Documentation was updated. Currently all links work as intended.)
- [x] **Add Missing Information**:
- Services - Complete service descriptions for all middleware services, proofread :white_check_mark:
- About - Extend information at the top, then proofread :white_check_mark:
- Applications - proofread :white_check_mark:
- Download - Add "Getting Started" quickstart guide, under the Download section, add some useful links :white_check_mark:
- Include architecture overview diagram showing how services interact :question:
- List key features and capabilities :question:
- [x] **Expand Collaboration Section**:
- Highlight community contribution opportunities :white_check_mark:
- Include community communication channels (Matrix, GitHub, mailing lists) :white_check_mark:
- ~~Add community calendar (codeathons, meetings, webinars)~~ Add a list of upcoming events instead :white_check_mark:
- Contribute overhaul :white_check_mark:
- ~~Showcase~~ Add missing community contributors and facilities using Phoebus :white_check_mark:
- Create and Link to CONTRIBUTING.md in main repository :white_check_mark:
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
- ~~Add "How to Contribute" section with clear paths for different skill levels~~ not needed, makes it less complicated
- [ ] **Technical Updates**:
- Update site generator dependencies and Improve build process and deployment
- Add analytics to understand user engagement
Expand All @@ -202,9 +206,7 @@ Phoebus.org serves as the main landing page for the Phoebus ecosystem but has ou
- Current site: https://phoebus.org (or phoebus-doc.readthedocs.io)
- Discussion topic: [4.4 Documentation Strategy](discussion-topics/README.md#44-documentation-strategy)

**Assigned To:** Anna Ziegler (HZB)
**Status:** 70% Complete
**Notes:** Updated all Links and References, Added Missing Information, Proofread and improved all Texts, Added "Quickstart Guide" in Download section, Added upcoming Events section, Contribute overhaul. See https://github.com/ControlSystemStudio/phoebus-codeathon/tree/master/documentation-tasks
**Assigned To:**

---

Expand Down
Back | FazBrowse Home | New Git URL