From 5d8287f867dde887db41af63df5bc824f83fd407 Mon Sep 17 00:00:00 2001 From: Nathalie Redick Date: Thu, 7 May 2026 13:19:34 -0700 Subject: [PATCH 1/5] separate build and deploy of site; closes #36 --- .github/workflows/build-and-deploy.yml | 34 ++++++++++++++++---------- 1 file changed, 21 insertions(+), 13 deletions(-) diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml index 997d6b7..6f312e3 100644 --- a/.github/workflows/build-and-deploy.yml +++ b/.github/workflows/build-and-deploy.yml @@ -1,28 +1,27 @@ name: Build & Deploy Docs permissions: - contents: read # 'read' is sufficient for checkout - pages: write # Required to deploy to Pages - id-token: write # Required to verify the deployment + contents: read + pages: write + id-token: write on: push: branches: [main] + pull_request: # Added: Build will now check every PR + branches: [main] workflow_dispatch: jobs: - build-deploy: + # JOB 1: Build and Verify (Runs on PRs and Pushes) + build: runs-on: ubuntu-latest - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - steps: - name: Checkout main repo - uses: actions/checkout@v6 + uses: actions/checkout@v4 - name: Set up Conda - uses: conda-incubator/setup-miniconda@v4 + uses: conda-incubator/setup-miniconda@v3 with: activate-environment: vrui environment-file: environment.yml @@ -33,7 +32,7 @@ jobs: shell: bash -el {0} run: bash scripts/clone_docs.sh - - name: Generate mkdocs.yml + - name: Generate zensical config shell: bash -el {0} run: python scripts/generate_zensical.py @@ -42,10 +41,19 @@ jobs: run: zensical build --config-file zensical.generated.toml --clean - name: Upload artifact - uses: actions/upload-pages-artifact@v5 + uses: actions/upload-pages-artifact@v3 with: path: 'site' + # JOB 2: Deploy (Only runs on main after Build succeeds) + deploy: + needs: build + if: github.event_name == 'push' && github.ref == 'refs/heads/main' + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v5 \ No newline at end of file + uses: actions/deploy-pages@v4 \ No newline at end of file From 6516427ef7d1891b9863bf51579aae4efdb7957e Mon Sep 17 00:00:00 2001 From: Zeeva Chaver Date: Fri, 17 Apr 2026 10:17:34 -0700 Subject: [PATCH 2/5] add untracked files --- docs/governance.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++ docs/readme.md | 1 + 2 files changed, 56 insertions(+) create mode 100644 docs/governance.md create mode 100644 docs/readme.md diff --git a/docs/governance.md b/docs/governance.md new file mode 100644 index 0000000..b7eec02 --- /dev/null +++ b/docs/governance.md @@ -0,0 +1,55 @@ +# Vrui Governance + +The Vrui Ogranization develops and deploys open source software for collaborative, 3D data visualization and analysis in a range of VR/XR environments. + +The software developed and maintained by the Vrui Organization is released under the MIT (or similarly permissive) open source license, developed openly, and hosted in public GitHub repositories under the [Vrui: Virtual Reality User Inteface organization](https://github.com/vrui-vr). Examples of Project Software include the [Vrui Developer Tookit](https://github.com/vrui-vr/vrui), and the [3D LIDAR Viewer](https://github.com/vrui-vr/lidarviewer). + +The services run by the Vrui Organization consist of the develpment of VR and XR framworkds and applications for collaborative, scientific investegation of 3D data as well as hosting of virtual and phsyical events for the community of Vrui users and develpers as well as the wider VR/XR community. + +The Vrui Organization is formally affiliated with the [UC Davis DataLab](https://datalab.ucdavis.edu), which serves as its administrative home and includes partners from a range of government, academic, and commercial organizations. Vrui is currently financially supported by a grant from the [Alfred P. Sloan Foundation](https://sloan.org/) and through funds provided by the Office of the Provost of the University of California, Davis. + +## Governance + +This section describes the governance and leadership model of The Project. + +The foundations of Project governance are: + +- Openness & Transparency +- Active Contribution +- Institutional Neutrality + +The Project is lead by a Steering Committe that is currently comprised of the following members: + +* [Dr. Frank Klassner](http://www.csc.villanova.edu/~klassner/), Department of Computer Science, Villanova University. +* [Dr. Oliver Kreylos](https://datalab.ucdavis.edu/team/), University of California Davis, DataLab +* [Dr. William Sherman](https://www.nist.gov/people/william-sherman), United States National Institute of Standards and Technology +* [Dr. Carl Stahmer](https://datalab.ucdavis.edu/team/), University of California Davis, DataLab +* [Dr. Simon Su](https://www.nist.gov/people/simon-su), United States National Institute of Standards and Technology + + +Decision making is conducted by the Steering Committee using a Consensus decision-making process under which participants work together to develop proposals for actions that achieve a broad acceptance. Consensus is reached when everyone in the group assents to a decision. A minority of individual members may choose to "Stand Aside" as part of any decision-making process and concensus will still be determined to have been achieved. + +The Vrui Organization Steering Committee is responsible for all business decisions affecting the organization, for developing and maintining the Organization's Development Roadmap as well as the Development Roadmap for the [Vrui Toolkit](https://github.com/vrui-vr/vrui), and for receiving, reviweing, and acting upon any reports of any violations of the Vrui Organization [Code of Conduct](https://github.com/vrui-vr/.github/blob/main/CODE_OF_CONDUCT.md). + +Additional activities undertaken by the Steering Committe include: + +- Make decisions about the overall scope, vision, and direction of The Project. +- Make decisions about strategic collaborations with other organizations or individuals. +- Make decisions about community virtual and physical events and activities. +- Make decisions when regular community discussion doesn’t produce consensus on an issue in a reasonable time frame. +- Manage and maintain the orginzation's Governance Documentation. + +Oversight of Development Roadmaps and acceptance of code pull requests on the remander of the Vrui Organization's applications and repositories is perfomed by a Technical Oversight Committe as described below. + +### Technical Oversight Committee + +The Vrui Organization's Technical Oversight Committee operates under a Benevolent Dictator for Life (BDFL) model. Vrui's current BDFL is currently Oliver Kreylos, Vrui's inventor and original developer. As Dictator, the BDFL has the authority to make all final technical decisions for the Organization. The BDFL, being benevolent, in practice chooses to defer that authority to the consensus of the community discussion channels and the consensus of the other members of the Technical Oversight Committee (see below). It is expected, and in the past has been the case, that the BDFL will only rarely assert their final authority. Because rarely used, we refer to BDFL’s final authority as a “special” or a “consensus overriding” vote. When it does occur, the BDFL override typically happens in situations where there is a deadlock in the Technical Oversight Committee or if the members of the Technical Oversight Committee asks the BDFL to make a decision on a specific matter. To ensure the benevolence of the BDFL, The Project encourages others to fork the project if they disagree with the overall direction the BDFL is taking. The BDFL is chair of the Technical Oversight Committee and may delegate their authority on a particular decision or set of decisions to any other Council member at their discretion. + +When the BDFL determines that the time is appropriate, the BDFL shal nominate a successor, who shall be approved by a majority vote (not concensus) of the Vrui Organization Steering Committee. If the BDFL is unable to appoint a successor, the Steering Committee will appoint a successor with a majority vote. + +### Technical Oversight Committee Membership + +Members of the Techni al Oversight Committee, in addition to the BDFL, are appointed by a concensus decision of the Vrui Organization Steering Committee. Current members of the Technical Oversight Committee include: + +* **BDFL**: [Dr. Oliver Kreylos](https://datalab.ucdavis.edu/team/), University of California Davis, DataLab +* [Andrew Grace](https://www1.villanova.edu/university/liberal-arts-sciences/programs/computing-sciences/faculty/biodetail.html?mail=andrew.grace@villanova.edu&xsl=bio_long), Department of Computer Science, Villanova University diff --git a/docs/readme.md b/docs/readme.md new file mode 100644 index 0000000..475106e --- /dev/null +++ b/docs/readme.md @@ -0,0 +1 @@ +The Vrui (Virtual Reality User Interface) Toolkit is a comprehensive development framework designed to facilitate the creation of immersive virtual reality applications. It provides a suite of tools and libraries that enable developers to build VR software with advanced 3D user interfaces, supporting a wide range of input devices and display systems. Vrui emphasizes flexibility and scalability, making it suitable for applications in scientific visualization, data exploration, and other fields requiring interactive 3D environments. From 25c290b68aa6735c22c60780e4adbe1844b8ba71 Mon Sep 17 00:00:00 2001 From: Zeeva Chaver Date: Fri, 17 Apr 2026 10:21:43 -0700 Subject: [PATCH 3/5] rm files that do not belong --- docs/governance.md | 55 ---------------------------------------------- docs/readme.md | 1 - 2 files changed, 56 deletions(-) delete mode 100644 docs/governance.md delete mode 100644 docs/readme.md diff --git a/docs/governance.md b/docs/governance.md deleted file mode 100644 index b7eec02..0000000 --- a/docs/governance.md +++ /dev/null @@ -1,55 +0,0 @@ -# Vrui Governance - -The Vrui Ogranization develops and deploys open source software for collaborative, 3D data visualization and analysis in a range of VR/XR environments. - -The software developed and maintained by the Vrui Organization is released under the MIT (or similarly permissive) open source license, developed openly, and hosted in public GitHub repositories under the [Vrui: Virtual Reality User Inteface organization](https://github.com/vrui-vr). Examples of Project Software include the [Vrui Developer Tookit](https://github.com/vrui-vr/vrui), and the [3D LIDAR Viewer](https://github.com/vrui-vr/lidarviewer). - -The services run by the Vrui Organization consist of the develpment of VR and XR framworkds and applications for collaborative, scientific investegation of 3D data as well as hosting of virtual and phsyical events for the community of Vrui users and develpers as well as the wider VR/XR community. - -The Vrui Organization is formally affiliated with the [UC Davis DataLab](https://datalab.ucdavis.edu), which serves as its administrative home and includes partners from a range of government, academic, and commercial organizations. Vrui is currently financially supported by a grant from the [Alfred P. Sloan Foundation](https://sloan.org/) and through funds provided by the Office of the Provost of the University of California, Davis. - -## Governance - -This section describes the governance and leadership model of The Project. - -The foundations of Project governance are: - -- Openness & Transparency -- Active Contribution -- Institutional Neutrality - -The Project is lead by a Steering Committe that is currently comprised of the following members: - -* [Dr. Frank Klassner](http://www.csc.villanova.edu/~klassner/), Department of Computer Science, Villanova University. -* [Dr. Oliver Kreylos](https://datalab.ucdavis.edu/team/), University of California Davis, DataLab -* [Dr. William Sherman](https://www.nist.gov/people/william-sherman), United States National Institute of Standards and Technology -* [Dr. Carl Stahmer](https://datalab.ucdavis.edu/team/), University of California Davis, DataLab -* [Dr. Simon Su](https://www.nist.gov/people/simon-su), United States National Institute of Standards and Technology - - -Decision making is conducted by the Steering Committee using a Consensus decision-making process under which participants work together to develop proposals for actions that achieve a broad acceptance. Consensus is reached when everyone in the group assents to a decision. A minority of individual members may choose to "Stand Aside" as part of any decision-making process and concensus will still be determined to have been achieved. - -The Vrui Organization Steering Committee is responsible for all business decisions affecting the organization, for developing and maintining the Organization's Development Roadmap as well as the Development Roadmap for the [Vrui Toolkit](https://github.com/vrui-vr/vrui), and for receiving, reviweing, and acting upon any reports of any violations of the Vrui Organization [Code of Conduct](https://github.com/vrui-vr/.github/blob/main/CODE_OF_CONDUCT.md). - -Additional activities undertaken by the Steering Committe include: - -- Make decisions about the overall scope, vision, and direction of The Project. -- Make decisions about strategic collaborations with other organizations or individuals. -- Make decisions about community virtual and physical events and activities. -- Make decisions when regular community discussion doesn’t produce consensus on an issue in a reasonable time frame. -- Manage and maintain the orginzation's Governance Documentation. - -Oversight of Development Roadmaps and acceptance of code pull requests on the remander of the Vrui Organization's applications and repositories is perfomed by a Technical Oversight Committe as described below. - -### Technical Oversight Committee - -The Vrui Organization's Technical Oversight Committee operates under a Benevolent Dictator for Life (BDFL) model. Vrui's current BDFL is currently Oliver Kreylos, Vrui's inventor and original developer. As Dictator, the BDFL has the authority to make all final technical decisions for the Organization. The BDFL, being benevolent, in practice chooses to defer that authority to the consensus of the community discussion channels and the consensus of the other members of the Technical Oversight Committee (see below). It is expected, and in the past has been the case, that the BDFL will only rarely assert their final authority. Because rarely used, we refer to BDFL’s final authority as a “special” or a “consensus overriding” vote. When it does occur, the BDFL override typically happens in situations where there is a deadlock in the Technical Oversight Committee or if the members of the Technical Oversight Committee asks the BDFL to make a decision on a specific matter. To ensure the benevolence of the BDFL, The Project encourages others to fork the project if they disagree with the overall direction the BDFL is taking. The BDFL is chair of the Technical Oversight Committee and may delegate their authority on a particular decision or set of decisions to any other Council member at their discretion. - -When the BDFL determines that the time is appropriate, the BDFL shal nominate a successor, who shall be approved by a majority vote (not concensus) of the Vrui Organization Steering Committee. If the BDFL is unable to appoint a successor, the Steering Committee will appoint a successor with a majority vote. - -### Technical Oversight Committee Membership - -Members of the Techni al Oversight Committee, in addition to the BDFL, are appointed by a concensus decision of the Vrui Organization Steering Committee. Current members of the Technical Oversight Committee include: - -* **BDFL**: [Dr. Oliver Kreylos](https://datalab.ucdavis.edu/team/), University of California Davis, DataLab -* [Andrew Grace](https://www1.villanova.edu/university/liberal-arts-sciences/programs/computing-sciences/faculty/biodetail.html?mail=andrew.grace@villanova.edu&xsl=bio_long), Department of Computer Science, Villanova University diff --git a/docs/readme.md b/docs/readme.md deleted file mode 100644 index 475106e..0000000 --- a/docs/readme.md +++ /dev/null @@ -1 +0,0 @@ -The Vrui (Virtual Reality User Interface) Toolkit is a comprehensive development framework designed to facilitate the creation of immersive virtual reality applications. It provides a suite of tools and libraries that enable developers to build VR software with advanced 3D user interfaces, supporting a wide range of input devices and display systems. Vrui emphasizes flexibility and scalability, making it suitable for applications in scientific visualization, data exploration, and other fields requiring interactive 3D environments. From 1f7282ae1991256eb3f82a1d7ad1fc7c450f6530 Mon Sep 17 00:00:00 2001 From: Zeeva Chaver Date: Fri, 17 Apr 2026 12:02:38 -0700 Subject: [PATCH 4/5] correct filenames in gitignore --- .gitignore | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index ad2d39f..62f2303 100644 --- a/.gitignore +++ b/.gitignore @@ -6,8 +6,8 @@ docs/arsandbox docs/vrui docs/kinect docs/3dvisualizer -docs/CODE_OF_CONDUCT.md -docs/CONTRIBUTING.md +docs/code_of_conduct.md +docs/contributing.md docs/assets/GitHub_Header_Discussions.png docs/assets/GitHub_Header_Issues.png From fcae9c0eade0c605baa30757156441cbd8e836cb Mon Sep 17 00:00:00 2001 From: Zeeva Chaver Date: Fri, 15 May 2026 10:30:18 -0700 Subject: [PATCH 5/5] minor changes to template files --- docs/shared/pullpackage.md | 2 +- docs/shared/pullpackage_kinect.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/shared/pullpackage.md b/docs/shared/pullpackage.md index a8acfcb..a00ff64 100644 --- a/docs/shared/pullpackage.md +++ b/docs/shared/pullpackage.md @@ -17,7 +17,7 @@ In detail, the prerequisite installation steps are as follows: #### Install PullPackage -To install the PullPackage package manager, copy the command from the following box into a terminal window and press the Enter key: +To install the PullPackage package manager, copy the command from the following box into a terminal window and press ++enter++: ```sh curl https://vroom.library.ucdavis.edu/PullPackage | bash diff --git a/docs/shared/pullpackage_kinect.md b/docs/shared/pullpackage_kinect.md index 21322d1..febee10 100644 --- a/docs/shared/pullpackage_kinect.md +++ b/docs/shared/pullpackage_kinect.md @@ -6,8 +6,8 @@ The Kinect package contains drivers for several types of 3D cameras that are use PullPackage Kinect ``` - -```sh -PullPackage Vrui && PullPackage Kinect -``` --> \ No newline at end of file + + + \ No newline at end of file