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

Cleanup of workspace directory. Is this even an issue? #3

Open
2 tasks done
tnabtaf opened this issue Jan 27, 2023 · 1 comment
Open
2 tasks done

Cleanup of workspace directory. Is this even an issue? #3

tnabtaf opened this issue Jan 27, 2023 · 1 comment

Comments

@tnabtaf
Copy link
Contributor

tnabtaf commented Jan 27, 2023

Checklist

  • I added a descriptive title
  • I searched open requests and couldn't find a duplicate

What is the idea?

Background

As discussed in the Conda Communications Matrix Room we decided to use this GitHub repo as a collaborative workspace for drafting posts that will be placed elsewhere, such as on the community website, or the community forum.

Pull request #2 establishes the /workspace directory for this purpose. That PR also includes a README with suggestions on how to work in that directory. That guidance is minimal.

But we don't want search engines to search the /workspace directory

We don't want searches pointing people to our directory. We want them to point people to where the post was published.

How do we accomplish this? Is this even a problem?

Some ideas:

  • Delete pages once they are posted.
    • However, there is value in having a directory of posts we have already created. When we need to create something similar, we can just start with an easy to find copy of what we already did.
  • Replace the draft page with a link to the URL where it was published.
    • This would work, and if we keep pages around then it would be good to track where they ended up anyway. People would also be able to find the source through GitHub's history.
  • Use GitHub to tell search engines not to go there!
    • This is the cleanest option, I just can't figure out how to do it...

What do you think? Whatever we decide will be added to the guidelines.

Why is this needed?

Well, it may not be needed, but it has certainly been a problem with GitHub repos in the past.

What should happen?

Let's see. The user here is the person who publishes the page and then has to do cleanup in GitHub.

So, unless we can get GitHub to block indexing, this would mean extra work for the poster, once the item has been published elsewhere.

Additional Context

No response

@jezdez
Copy link
Member

jezdez commented Jan 30, 2023

I think it would be useful to move documents from the workspace into folders that match the category of the post, e.g. if we have a release announcement it would move from workspace to news or something?

I wonder if drafts would be a better title for workspace until the drafts are reviewed?

I could even image driving the publication from this repo automatically, it's not hard to build a GitHub Action Workflow that automatically publishes to Discourse when a file is added to a directory, e.g. news and opens a new pull request in the conda-dot-org repository as well.

tnabtaf added a commit to tnabtaf/communications that referenced this issue Feb 2, 2023
A couple of changes:

* Updated directory structure to agree with current proposal in
/workspace/READM.md
* Added data posted to page, and put most content in an HTML comment.  See
issue conda#3 for why.
tnabtaf added a commit that referenced this issue Feb 2, 2023
A couple of changes:

* Updated directory structure to agree with current proposal in
/workspace/README.md
* Added data posted to page, and put most content in an HTML comment.  See
issue #3 for why.
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

No branches or pull requests

2 participants