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

Adds tabbed content, annotations, and admonitions #30

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

Burhan-Q
Copy link
Contributor

Overview

Proposal to some updates for new docs pages. Specifically for

  • docs\getting_started\basic\install.md
  • docs\getting_started\basic\virtualenv.md
  • docs\fiftyone_concepts\running_environments.md

Apologies for the big PR. I intended originally to specifically add the tabbed content, but found several other areas that felt (to me) could use some attention.

Summary of Changes

  • reordered markdown_extensions alphabetically
  • included tabbed content to provide cleaner interface in documentation
  • added annotations for interactive pop-out comments
  • added frontmatter for keywords to help surface relevant content
  • reordered OSes (only on these three pages) to maintain consistent order
  • included install examples for uv
  • changed syntax highlights to shell where appropriate
  • changed syntax highlights to json where appropriate
  • included examples for setting environment variables in multiple OSes
  • added spaces in mkdocs.yml per yaml-lint errors (ignored other errors as it was not obvious that they needed to be fixed)
  • added step numbers for connect to remote data steps
  • removed $ and >>> from code blocks for consistency
  • reformatted directory preview to use tree notation

Preview

Admonitions and Tabbed content (expand for screenshot)

Image

Image

Image

Image

Admonitions and Annotations (expand for screenshot)

Image

Image

@Burhan-Q Burhan-Q requested a review from a team as a code owner February 25, 2025 15:47
@thesteve0
Copy link
Collaborator

@Burhan-Q Can you please make an edit to the code in the pr (say update a doc page or something). We just implemented functionality that should build the entire site based on this PR. Doing so will make it easier for us to review changes.

@Burhan-Q
Copy link
Contributor Author

Burhan-Q commented Mar 2, 2025

@thesteve0 added some white space, hopefully that helps

@Burhan-Q
Copy link
Contributor Author

Burhan-Q commented Mar 2, 2025

Sorry on mobile at the moment, but seems like there's a permission problem

remote: Permission to voxel51/voxel51-docs.git denied to github-actions[bot].
fatal: unable to access 'https://github.com/voxel51/voxel51-docs.git/': The requested URL returned error: 403
Changes committed to the gh-pages branch… 📦
Running post deployment cleanup jobs… 🗑️
/usr/bin/git checkout -B github-pages-deploy-action/zp62jsw7x
Reset branch 'github-pages-deploy-action/zp62jsw7x'
/usr/bin/chmod -R +rw github-pages-deploy-action-temp-deployment-folder
/usr/bin/git worktree remove github-pages-deploy-action-temp-deployment-folder --force
Completed deployment successfully! ✅

Run marocchino/sticky-pull-request-comment@331f8f5b4215f0445d3c07b4967662a32a2d3e31
  
Error: Resource not accessible by integration

@thesteve0
Copy link
Collaborator

@tom-vx51 Looks like people outside 51 may get the permissions issue

@Burhan-Q
Copy link
Contributor Author

Burhan-Q commented Mar 3, 2025

Might need the token according to the GHA Readme

Authentication token for the preview deployment.
The default value works for non-fork pull requests to the same repository. For anything else, you will need a Personal Access Token with permission to access it, and store it as a secret in your repository. E.g. you might name that secret 'PREVIEW_TOKEN' and use it with token: ${{ secrets.PREVIEW_TOKEN }}.

Default: ${{ github.token }}, which gives the action permission to deploy to the current repository.

SOURCE

@Burhan-Q
Copy link
Contributor Author

Burhan-Q commented Mar 3, 2025

FWIW here's my fork permissions

Screenshot_20250303-115332

@Burhan-Q
Copy link
Contributor Author

Burhan-Q commented Mar 4, 2025

Is the preview action working properly for repo maintainers? I tried using it on my fork (again, trying it all from mobile) and this was the result https://burhan-q.github.io/voxel51-docs/pr-preview/pr-2/ where the main on my fork deployed without issue.

@thesteve0
Copy link
Collaborator

It's a known issue you can't deploy from forks :( - we are investigating a solution that will allow for community builds

rossjrw/pr-preview-action#6

@Burhan-Q
Copy link
Contributor Author

Burhan-Q commented Mar 6, 2025

FWIW, I've attached screenshots of the locally deployed changes in this PR

Install

voxel51-docs-install

Details

Default tabbed content

voxel51-docs-venv-alt-tab

Alternate tabbed content

voxel51-docs-venv-default

Running Environments (long)

voxel51-docs-running-environments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants