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

Update: Deprecate the documenting-ruby workflow and refer users to ruby/ruby #6

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

olleolleolle
Copy link

@olleolleolle olleolleolle commented Oct 7, 2017

This PR is an update to the Step-by-Step Guide which deprecates the workflow currently described on the website.

In order to avoid contributors have their PRs and issues waiting for review here, change the workflow to go towards ruby/ruby instead.

  • instruct users to clone ruby/ruby instead of documenting-ruby/ruby
  • try to keep the documentation published useful still

See also: documenting-ruby/ruby#82 (comment)

  - avoid referring people to this org's repository
  - try to keep the documentation published useful still
Copy link
Member

@davydovanton davydovanton left a comment

Choose a reason for hiding this comment

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

Great, thank you ❤️


Clone your new repo:
{% highlight bash %}
git clone [email protected]:YOUR_NAME/ruby.git
git clone [email protected]:ruby/ruby.git
Copy link
Member

Choose a reason for hiding this comment

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

I think, after fork you need to use clone [email protected]:YOUR_NAME/ruby.git WDYT?

Copy link
Author

Choose a reason for hiding this comment

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

A suspicion - that upper case word is a magic replacement constant in Github pages. Is this true?

Copy link
Author

Choose a reason for hiding this comment

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

Oh sorry, I was confused. I’ll amend this instruction text to be complete.

@olleolleolle
Copy link
Author

olleolleolle commented Oct 9, 2017

@davydovanton I managed to add some more text; most of it was to make a sentence around the GitHub Help article about Forking.

@olleolleolle olleolleolle changed the title Update: Refer only to ruby/ruby Update: Deprecate the documenting-ruby workflow and refer users to ruby/ruby Oct 9, 2017
@mcmire
Copy link

mcmire commented Apr 17, 2021

Hi, I was thinking of submitting some documentation updates to Ruby and remembered that this site was still a thing. Is it possible to merge this? I think it could be helpful to people.

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