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

Infrastucture docs have moved #99

Merged
merged 4 commits into from
Dec 17, 2024
Merged

Infrastucture docs have moved #99

merged 4 commits into from
Dec 17, 2024

Conversation

ljones140
Copy link
Contributor

Removes infrastructure documentation as that has been moved to the new private repo https://github.com/clearlydefined/infrastructure

Copy link
Collaborator

@elrayle elrayle left a comment

Choose a reason for hiding this comment

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

I did not do a full review. I did have a suggestion for the overview.md file. The suggestion described might apply to other files as well.

@@ -1,961 +0,0 @@
# Infrastructure Overview
Copy link
Collaborator

@elrayle elrayle Oct 18, 2024

Choose a reason for hiding this comment

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

There is a good bit of information used by devs when running on localhost for debugging and development. For example, they may need to set some of the env vars in their local environment. This type of information would be good to remain public.

There is also quite a bit of info that is not needed by devs, but is required to maintain the servers and systems. That info can be moved.

@ljones140
Copy link
Contributor Author

@elrayle and @qtomlinson I've added the env var configurations back.
I've put them in separate files to make reading easier.
And moved anything deployment focussed to the operations repo

Copy link
Collaborator

@qtomlinson qtomlinson left a comment

Choose a reason for hiding this comment

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

Thank you for separating the configs for the three services. It is much clearer!


Let's start off by taking a closer look at the **clearlydefined-dev** resource group.

## ClearlyDefined Dev Resource Group
Copy link
Collaborator

Choose a reason for hiding this comment

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

If we plan to consider Azure read rights for a future Contributors group (as discussed in our dev sync meeting on November 27), the overview.md document is a great guide. Could we ensure that the description of the "ClearlyDefined Dev Resource Group" remains publicly accessible? See details here.

@jeffmendoza Any thoughts?

@qtomlinson qtomlinson self-requested a review December 16, 2024 19:16
@ljones140 ljones140 merged commit 223409b into main Dec 17, 2024
2 checks passed
@ljones140 ljones140 deleted the move-docs branch December 17, 2024 16:07
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