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

Add Aviary org docs #225

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

Add Aviary org docs #225

wants to merge 2 commits into from

Conversation

cd-work
Copy link
Contributor

@cd-work cd-work commented Oct 17, 2024


NPM and PyPI do not seem to actually work yet. It seems like we need to explicitly support %2F as a separator in Aviary.

@cd-work
Copy link
Contributor Author

cd-work commented Oct 17, 2024

PyPI does work with properly supplied URL and NPM is confirmed fixed with https://github.com/phylum-dev/aviary/pull/77. So I think this should be good to go.

@cd-work cd-work marked this pull request as ready for review October 17, 2024 23:03
@cd-work cd-work requested a review from a team as a code owner October 17, 2024 23:03
andreaphylum
andreaphylum previously approved these changes Oct 18, 2024
Copy link

@andreaphylum andreaphylum left a comment

Choose a reason for hiding this comment

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

Just an observation. I'm not current with the part of the codebase responsible for that, but I wonder if a different separator could be used for org/group? I think having to include an explicit %2f might look confusing to some. All in all I don't think it's a big deal though.

@cd-work
Copy link
Contributor Author

cd-work commented Oct 18, 2024

Just an observation. I'm not current with the part of the codebase responsible for that, but I wonder if a different separator could be used for org/group? I think having to include an explicit %2f might look confusing to some. All in all I don't think it's a big deal though.

It must be url-encoded where I've done so. In the places where it isn't it would technically also be possible to url-encode it since we had to support decoding in Aviary for NPM, but I've left it as / since it's less confusing as you've stated yourself.

@cd-work cd-work requested a review from maxrake October 18, 2024 13:55
Copy link
Contributor

@furi0us333 furi0us333 left a comment

Choose a reason for hiding this comment

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

We should probably hold on merging this until I start transitioning people over to orgs.

docs/artifact_repositories/cargo.md Outdated Show resolved Hide resolved
docs/artifact_repositories/cargo.md Show resolved Hide resolved
docs/artifact_repositories/cargo.md Show resolved Hide resolved
docs/artifact_repositories/npm.md Show resolved Hide resolved
Copy link
Contributor

@maxrake maxrake left a comment

Choose a reason for hiding this comment

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

This was tested by checking it out locally and building/viewing the pages.

Our documentation styles and sensibilities are at odds once again when it comes to verbosity 😜...but not enough to hold up this review.

@cd-work
Copy link
Contributor Author

cd-work commented Oct 18, 2024

Holding this PR until @furi0us333 decides it's good to go. From a technical perspective it should be complete.

@matt-phylum matt-phylum removed their request for review October 22, 2024 13:19
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.

4 participants