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

Moving release procedures into a dev folder instead of the user-facing docs folder #2840

Closed
wants to merge 65 commits into from

Conversation

davidcok
Copy link
Collaborator

@davidcok davidcok commented Oct 4, 2022

By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.

davidcok and others added 30 commits January 29, 2021 12:41
davidcok added 22 commits September 7, 2022 11:38
Copy link
Member

@cpitclaudel cpitclaudel left a comment

Choose a reason for hiding this comment

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

Is there a reason to rename from docs/dev/RELEASE to dev/RELEASE?

@davidcok
Copy link
Collaborator Author

davidcok commented Oct 4, 2022

The docs folder contains user-facing documentation (which is copied as is into the documentation snapshots). The Release procedure is development information. Robin wanted it kept in git (I had earlier proposed moving it to the wiki). So a dev folder seemed a good solution. Other ideas are welcome.

@cpitclaudel
Copy link
Member

We could exclude it from the build if we really want to not have it on the public website, but docs/ is the first place I'd look when searching for that info, and I don't think dev is standard for that?

But is it really bad to have it on the website? Having a "developer documentation" section is a good thing, I would think.

@davidcok
Copy link
Collaborator Author

davidcok commented Oct 4, 2022

Abandoning this PR -- not moving the dev material - instead not copying it into the snapshots -- cf. PR 2845

@davidcok davidcok closed this Oct 4, 2022
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.

None yet

2 participants