-
Notifications
You must be signed in to change notification settings - Fork 10
Update docs to reflect organization change #195
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates documentation and configuration files to reflect the organizational transition from Intel to P3HPC. The changes systematically replace Intel-branded URLs, email addresses, and references with their P3HPC equivalents while removing Intel-specific policy references.
- Updates all GitHub repository URLs from
intel/code-base-investigator
toP3HPC/code-base-investigator
- Changes documentation site URLs from
intel.github.io
top3hpc.github.io
- Removes Intel-specific security and code of conduct contact information
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
pyproject.toml | Updates author email and GitHub project URLs |
docs/source/*.rst | Updates repository and documentation links in RST files |
SECURITY.md | Replaces Intel security policy with GitHub Security Advisory process |
README.md | Updates installation URLs and documentation links |
CONTRIBUTING.md | Updates pull request and issue URLs |
CODE_OF_CONDUCT.md | Removes Intel-specific enforcement contact |
CITATION.cff | Updates repository URL for citations |
"Github" = "https://www.github.com/intel/code-base-investigator" | ||
"Issues" = "https://www.github.com/intel/code-base-investigator/issues" | ||
"Pull requests" = "https://www.github.com/intel/code-base-investigator/pulls" | ||
"Github" = "https://www.github.com/P3HPC/code-base-investigator" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The key should be "GitHub" with a capital H, not "Github". This maintains consistency with GitHub's official branding.
"Github" = "https://www.github.com/P3HPC/code-base-investigator" | |
"GitHub" = "https://www.github.com/P3HPC/code-base-investigator" |
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@laserkelvin - I think you wrote this originally, and I don't know if the capitalization is important. I'm happy to accept Copilot's suggestion here, but I'm hoping you can confirm it won't break anything.
Code Base Investigator is no longer an Intel-managed open source project. Signed-off-by: John Pennycook <[email protected]>
5e349fa
to
8053844
Compare
Presumably the Copyright is maintained up to 2024, and so is correct? I also note there are a few files that will subsequently contain "broken" links (though I'm sure GitHub will fix them transparently)
|
Signed-off-by: John Pennycook <[email protected]>
Yes, I think so. The copyright notice going forward can be updated, but my understanding is that we cannot and should not remove the existing copyright notice.
Good catch! I've fixed these in 2ce559e. |
Apologies, my grep finds some additional things that I guess should be removed/updated?
Less sure about:
Everything else looks to be a copyright notice, and some of the above might still be grandfathered in correctly. |
Signed-off-by: John Pennycook <[email protected]>
No need to apologize; this is exactly why I asked for a review!
These are the same notice, configured in two different places. The notice only applies to the documentation, and the current documentation was written entirely by Intel, so I think we should leave these for the time being. Once there are some other contributors and we update the copyright notices, we can change this to say something like "Intel Corporation and the P3HPC community".
Another good catch! I've fixed this in ef617a4. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't find anything else untoward in an automated fashion at least...! All looks good.
Code Base Investigator is no longer an Intel-managed open source project.
Related issues
N/A
Proposed changes
@laserkelvin, I can no longer officially request review from you, but I'd appreciate it if you could take a look. If you and @swright87 think this looks good, and agree I haven't missed anything, I'll make an equivalent set of changes for the P3 Analysis Library repository.