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

remove irc page and point to gitlab instead #268

Closed

Conversation

evykassirer
Copy link
Member

addresses #248
added some stuff from our page to the gitlab page so no info is lost: https://git.uwaterloo.ca/wics/documentation/wikis/irc

@ehashman ehashman temporarily deployed to wics-site-pr-268 October 7, 2016 00:03 Inactive
@annalorimer
Copy link
Member

Can people who don't have UWaterloo credentials still access the gitlab? I believe that people also have to be added to the GitLab project to see the wiki.

@evykassirer
Copy link
Member Author

oh damn you do have to sign in

you don't need to be added to the project though, since the documentation project is public

I'll just copy the file over from the wiki to the irc page I guess?

@annalorimer
Copy link
Member

Oh we copied the internal wiki to the documentation page? Nice.

It's pretty lengthy to just copy and paste. Maybe make a separate page and link to it.

@evykassirer
Copy link
Member Author

we didn't copy the internal wiki (I think, not sure what you mean)

there's multiple projects on gitlab, and the irc documentation is in the public project (the one wics-sys uses)

I'd copy and paste it to the separate page that already existed (that I just deleted)

@annalorimer
Copy link
Member

I was refering to the wics-eyes-only wiki vs the wics/documentatin wiki.

Sounds good!

@evykassirer
Copy link
Member Author

oh I don't think it was ever on the internal wiki (or if it was, someone must've moved it over ^_^)

@annalorimer
Copy link
Member

Oh you're right, it links to the documentation project. My bad!

@evykassirer evykassirer force-pushed the update_irc_documentation branch from 416458e to 2ae966f Compare October 9, 2016 15:38
@evykassirer evykassirer temporarily deployed to wics-site-pr-268 October 9, 2016 15:39 Inactive
- `ssh [email protected]` (for CSC) - If you don’t have an
account, visit the CSC office and pay $2 to sign up
- `ssh [email protected]` (for WiCS) - If you don’t have
a userid, ask Fatema to create one.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would link to the wics-sys mailing list instead of Fatema--this should fall under whoever is currently sysadmin

Copy link
Member Author

Choose a reason for hiding this comment

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

yeah, definitely. good point

[Computer Science Club](https://csclub.uwaterloo.ca) membership for $2 per
term, which grants you access to the CSC network.
#### WeeChat
Weechat has become a favourite among committee, so if you like to have a gui
Copy link
Contributor

Choose a reason for hiding this comment

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

among the committee?

Copy link
Member

Choose a reason for hiding this comment

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

I would shorten this to "WeeChat is good if you like to have a GUI". I find instructions really hard to follow when they're wordy.

8. Go to the oftc screen, in glowing-bear click on the bear’s face, and click
on oftc, in weechat android click on the W in the top-left corner
- `/join #wics` (public conversation)
- `/join #wics-sys`
Copy link
Contributor

Choose a reason for hiding this comment

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

I would add a description of the purpose of wics-sys

and point-and-clickness, we recommend you try this first. It also has
notifications on phone and desktop, and you are always connected if you keep it
on a screen.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think we can move the bit that says "you need an account on taurine or mother-goose before setting up IRC" and also instructions on how to do that (go to CSC with $2/ email wics-sys) before the steps.

- `/join $channel` (e.g. `/join #wics`): This is the command used to join a
channel
- `/q $nick` (e.g. `/q evy`): This opens a "query" window with another user.
This is used to PM someone. You can then switch to that window and chat with
Copy link
Contributor

@arshiamufti arshiamufti Oct 10, 2016

Choose a reason for hiding this comment

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

"PM" -> "PM (private message or direct message)" ?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think I'll just get rid of PM and say 'privately message'

@evykassirer
Copy link
Member Author

Thanks for the feedback Arshia - I just copied and pasted from our wiki and this should really be clearer than that doc ^_^

@@ -18,9 +18,9 @@ we do not publish our logs. Communication in the channel is governed by our
[Code of Conduct]({filename}/pages/code-of-conduct.md). If you haven't given it
a read yet, please take a few minutes to familiarize yourself with it!

# Installation instructions #
## Setting Up IRC (you can pick any of these options)
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 "Use whichever option works best for you" would be better on the line below the title. It's an instruction, so it doesn't super fit being in the header.

5. To set up on a web browser, go to glowing-bear.org, and enter the
information, (eg. host: taurine.uwaterloo.ca; port: 00009; password:
butts123)
6. To set up on your phone, download WeeChat Android, or the Glowing Bear app,
Copy link
Member

Choose a reason for hiding this comment

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

Having 5 & 6 as separate steps makes it seem like you have to do both to get WeeChat to work. Maybe combine this in to a single step?

butts123)
6. To set up on your phone, download WeeChat Android, or the Glowing Bear app,
and go to settings>connection settings, fill out the same information again
7. Either in the app or the web interface, you need to join all the channels
Copy link
Member

Choose a reason for hiding this comment

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

In this step, it says that "you need to join all channels" but that doesn't actually happen in this step. This can probably be combined with 8.

account, visit the CSC office and pay $2 to sign up
- `ssh [email protected]` (for WiCS) - If you don’t have
a userid, ask Fatema to create one.
2. type into the terminal `screen weechat`
Copy link
Member

Choose a reason for hiding this comment

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

The word after the numbers should be capitalized :)

@annalorimer
Copy link
Member

@evykassirer @arshiamufti What's the status of this?

@evykassirer
Copy link
Member Author

haven't been working on it for a while since it's not urgent. I'll try to get it done this term though, or someone else can take it on if they want!

@annalorimer
Copy link
Member

It'd be nice if we could sort this out soon... It's been open for a while and I don't think it'll take long to fix.

@evykassirer
Copy link
Member Author

well, I don't think it's more important than #249 which took months

If I do it, it'll probably be in the next month. I'm also happy for someone else to take it on if we want it sooner :)

@annalorimer
Copy link
Member

@wics-uw/contributors It'd be nice to get feedback from people currently trying to use the documentation :) Let us know what you think needs fixing.

@evykassirer evykassirer deleted the update_irc_documentation branch July 17, 2017 18:38
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.

4 participants