Skip to content
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.

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

docs: Prep 3.3.x documentation #97

Merged
merged 2 commits into from
Feb 26, 2024
Merged

docs: Prep 3.3.x documentation #97

merged 2 commits into from
Feb 26, 2024

Conversation

RobertGemmaJr
Copy link
Member

Note that this is merging in a holding branch. The documentation and 3.3 release of Honeycomb will be merged at the same time

  • Specifies a 3.2.x version of the documentation
  • Sets the current version of the documentation as 3.3.x

@RobertGemmaJr RobertGemmaJr added this to the Version 3.3 Release milestone Feb 12, 2024
@RobertGemmaJr RobertGemmaJr self-assigned this Feb 12, 2024
Copy link
Member

@tdivoll tdivoll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, Rob! I just put suggestions for small grammar things. Should versioned_docs/version-3.2.x folder be renamed now to versioned_docs/version-3.3.x?

versioned_docs/version-3.2.x/quick_start.mdx Show resolved Hide resolved
versioned_docs/version-3.2.x/quick_start.mdx Show resolved Hide resolved
versioned_docs/version-3.2.x/quick_start.mdx Show resolved Hide resolved
versioned_docs/version-3.2.x/variants.mdx Show resolved Hide resolved
Copy link
Member Author

@RobertGemmaJr RobertGemmaJr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tdivoll This PR moves all of the 3.2.x documents into a versioned folder in preperation for the new "latest" (3.3) docs.

I made the suggested changes in a different PR that I'll tag you on!


Connect the open source event trigger to the computer running the task using a USB to micro-USB cable. Check your operating system’s USB device list to identify the product ID of the teensyduino event marker.

Create a new system environment variable: `EVENT_MARKER_PRODUCT_ID` and set to the product ID of the event marker.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a bunch of .env files for some "defaults" that I think is intuitive enough. It's definitely something we have plans to rewrite though, so that will come

| git push | upload staged commit to repo |
| git pull | get remote repo commits and download \(try and resolve conflicts\) |
| git clone <url> | download entire repository |
| git checkout <branch> | checkout and create the branch you want to use |
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I separated git checkout <branch> and git checkout -b <branch>

- `release.yml`: Every time a release is created, edited, or published installers for the Honeycomb app are created and uploaded to the release. This also builds a PsiTurk version and deploys the app to GitHub pages.
- `workflow-package.yaml`: Create installers for any/all platforms for the `home` and/or `clinic` setting on demand. The installers/executables are uploaded as artifacts and are available for download from the GitHub Actions tab. This also builds a PsiTurk version when linux or all operating systems are selected.

:::note
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does!

@RobertGemmaJr RobertGemmaJr merged commit b64ddfd into feat-v3.3 Feb 26, 2024
1 check passed
@RobertGemmaJr RobertGemmaJr deleted the docs-3.3 branch February 26, 2024 15:37
@RobertGemmaJr RobertGemmaJr added the 3.3 Versioning: Issue in regards to version 3.3 release label Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.3 Versioning: Issue in regards to version 3.3 release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants