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 CI to docs + Password protect pages #287

Merged
merged 4 commits into from
Dec 17, 2024
Merged

Add CI to docs + Password protect pages #287

merged 4 commits into from
Dec 17, 2024

Conversation

jawadqur
Copy link
Contributor

@jawadqur jawadqur commented Dec 2, 2024

Link to JIRA ticket if there is one:

New Features

Breaking Changes

Bug Fixes

Improvements

  • Add a gh action to deploy doc site to gh pages w/ password

Dependency updates

Deployment changes

@jawadqur jawadqur marked this pull request as ready for review December 2, 2024 20:27
- stylesheets/extra.css
- encryptcontent:
password_inventory:
_global: 'gen3'
Copy link
Contributor

Choose a reason for hiding this comment

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

I realize this isn't necessarily intended to be secure, but having this plain text sorta defeats the purpose of trying to hide the content on the branches. I think this needs to be a real Github secret

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is just so that random people don't run into it for now, until we're ready to publish.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah but the repo is public so anyone can see this. So long as it's well understood that this isn't actually protecting against anything and folks writing the documentation understand that this does not actually prevent anyone from seeing the content, then it's okay. But configuring a secret on the repo and using that as a var here isn't too complicated and would alleviate my concern entirely

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, the intention behind this password is for crawlers not to index this page, not to hide the content from the public.

smvgarcia
smvgarcia previously approved these changes Dec 16, 2024
Copy link
Contributor

@smvgarcia smvgarcia left a comment

Choose a reason for hiding this comment

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

I think this will work to solve michael's problem

@Avantol13 Avantol13 dismissed their stale review December 16, 2024 22:35

changes made

@jawadqur jawadqur merged commit ce7c231 into master Dec 17, 2024
2 checks passed
@jawadqur jawadqur deleted the feat/staging-docs branch December 17, 2024 00:01
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.

3 participants