From eb211cc361f58b23f525baf365df28045efc531f Mon Sep 17 00:00:00 2001 From: Daniel Oaks Date: Tue, 23 Jun 2020 15:34:54 +1000 Subject: [PATCH] Initial set of changes --- CLA.md | 11 + CONTRIBUTING.md | 6 +- Gemfile.lock | 5 + README.md | 2 +- _data/contributors.yml | 5 +- _data/supported-servers.yml | 11 +- _includes/layouts/dev-default.html | 16 +- assets/styles/blog.scss | 2 - assets/styles/contact.scss | 147 ------ assets/styles/error.scss | 46 -- assets/styles/home.scss | 602 ----------------------- assets/styles/internal_pages.scss | 291 ----------- assets/styles/lets-take-irc-further.scss | 57 --- assets/styles/plugin.scss | 3 - assets/styles/social.scss | 302 ------------ assets/styles/timeline.scss | 196 -------- contact.html | 5 +- contributing.html | 4 +- guides/irc-dev/index.md | 10 +- index.html | 14 +- refs/index.html | 4 +- tools.html | 16 +- 22 files changed, 55 insertions(+), 1700 deletions(-) create mode 100644 CLA.md delete mode 100644 assets/styles/blog.scss delete mode 100644 assets/styles/contact.scss delete mode 100644 assets/styles/error.scss delete mode 100644 assets/styles/home.scss delete mode 100644 assets/styles/internal_pages.scss delete mode 100644 assets/styles/lets-take-irc-further.scss delete mode 100644 assets/styles/plugin.scss delete mode 100644 assets/styles/social.scss delete mode 100644 assets/styles/timeline.scss diff --git a/CLA.md b/CLA.md new file mode 100644 index 0000000..d1594aa --- /dev/null +++ b/CLA.md @@ -0,0 +1,11 @@ +# Contributor agreement + +By contributing any improvement, modification, or change to this project, I hereby certify that: + +(a) The contribution was authored or created in whole or in part by me and I have the full and unrestricted ownership right and title to submit the contribution under the project's license; or + +(b) The contribution is based upon previously authored work that, to the best of my knowledge, is licensed appropriately under an open source license and I have the full and unrestricted right under that open source license to submit that work with modifications, whether created in whole or in part by me, under the project's license; or + +(c) The contribution was lawfully provided to me by a licensed third-party who certified (a), (b) or (c) and I have not modified the contribution. + +I understand and agree that the contents of this project and the contents of this contribution are considered to be part of the public record and that a record of the contribution (including all personal information I submit with it) shall be maintained indefinitely and may be redistributed to third-parties consistent with this terms of this project or the open source license(s) involved. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d43653d..1555c41 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,5 @@ -# Contributing to the IRC Foundation Developer Docs -Welcome to the Foundation's developer documentation! Thank you very much for taking the time to contribute, it's always good to have more eyes looking at (and editing) these pages. +# Contributing to the IRC DevDocs +Welcome to IRC DevDocs! Thank you very much for taking the time to contribute, it's always good to have more eyes looking at (and editing) these pages. This page lists a set of guidelines and advice to simplify contributing to this project, and to (in the case of submitted changes) make it more likely that we'll accept your changes. @@ -31,7 +31,7 @@ Alright, let's go through each type of change: ### New Reference Page This is documenting a new command, numeric, or mode. We always appreciate new contributions, however there are some checks that we do due to the somewhat fragmented nature of IRC support out there. -If you're documenting a numeric, discuss your change with us on the [issue tracker](https://github.com/irccom/devdocs/issues). Specifically, tell us the number and the name of the numeric you're looking to describe. For example, something like: +If you're documenting a numeric, discuss your change with us on the [issue tracker](https://github.com/ircdocs/dd/issues). Specifically, tell us the number and the name of the numeric you're looking to describe. For example, something like: > **RPL_HELLO (020)** > diff --git a/Gemfile.lock b/Gemfile.lock index 7866083..52ac332 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -9,7 +9,9 @@ GEM eventmachine (>= 0.12.9) http_parser.rb (~> 0.6.0) eventmachine (1.2.7) + eventmachine (1.2.7-x64-mingw32) ffi (1.13.1) + ffi (1.13.1-x64-mingw32) forwardable-extended (2.6.0) git (1.7.0) rchardet (~> 1.8) @@ -58,12 +60,15 @@ GEM safe_yaml (1.0.5) sassc (2.4.0) ffi (~> 1.9) + sassc (2.4.0-x64-mingw32) + ffi (~> 1.9) terminal-table (1.8.0) unicode-display_width (~> 1.1, >= 1.1.1) unicode-display_width (1.7.0) PLATFORMS ruby + x64-mingw32 DEPENDENCIES git (~> 1.7) diff --git a/README.md b/README.md index 3faf4e7..03de650 100644 --- a/README.md +++ b/README.md @@ -51,4 +51,4 @@ Here are some other IRC references that devs may find useful: The project's [license file](./LICENSE) lays this out in detail, but as a non-normative summary we've designed the license so that: - If anyone modifies or builds on top of the content in this repo, we can pull those changes back into this project under this project's license. -- If IRC.com / the IRC Foundation or anyone else wants to take any of the content in this repo and pull it into the IETF process (for example, writing a new RFC describing the IRC protocol), they can do that and the content they use will be under the IETF contributor license terms. +- If anyone wants to take any of the content in this repo and pull it into the IETF process (for example, writing a new RFC describing the IRC protocol), they can do that and the content they use will be under the IETF contributor license terms. diff --git a/_data/contributors.yml b/_data/contributors.yml index 177f6ca..071d3c1 100644 --- a/_data/contributors.yml +++ b/_data/contributors.yml @@ -3,9 +3,8 @@ people: name: Daniel Oaks github: DanielOaks twitter: Daniel_Oaks - email: daniel+devdocs@irc.com - tagline: Lead protocol docs maintainer - nick: dan- / doaks + tagline: Lead DevDocs maintainer + nick: dan-  doaks orgs: - irccom - ircdocs diff --git a/_data/supported-servers.yml b/_data/supported-servers.yml index 36bb7ce..5453c79 100644 --- a/_data/supported-servers.yml +++ b/_data/supported-servers.yml @@ -33,14 +33,14 @@ shortlist: url: https://www.dal.net/?page=Bahamut desc: | Being written by and for [DALnet](https://www.dal.net/), Bahamut is a very stable IRC - server that doesn't follow newer standards. + server. - id: ratbox name: ircd-ratbox url: https://www.ratbox.org desc: | Being well-used on [EFnet](http://www.efnet.org/), ircd-ratbox is a stable and fast - IRC server that doesn't follow newer standards. + IRC server. - id: ngircd name: ngIRCd @@ -53,8 +53,7 @@ shortlist: name: ircu2 url: http://coder-com.undernet.org desc: | - Developed by and for the Undernet community, ircu2 is relatively well-used and does - not follow newer standards. + Developed by and for the Undernet community, ircu2 is relatively well-used. - id: hybrid name: ircd-hybrid @@ -68,5 +67,5 @@ shortlist: url: http://www.irc.org/servers.html desc: | The original IRC server, IRCd spawned a number of the servers listed here. Not - maintained today and having spawned the (in)famous RFC2812, we list the compatibility - of this server mostly for context and historical interest. + maintained today, we list the compatibility of this server mostly for context and + historical interest. diff --git a/_includes/layouts/dev-default.html b/_includes/layouts/dev-default.html index ae913af..234d6e9 100644 --- a/_includes/layouts/dev-default.html +++ b/_includes/layouts/dev-default.html @@ -3,7 +3,7 @@ - IRC Foundation Developer Documentation + IRC DevDocs - {{ page.title }} @@ -20,16 +20,15 @@
@@ -40,11 +39,11 @@
@@ -57,8 +56,9 @@
- IRC Foundation Logo +

© 2018 IRC.com

+

© 2020 ircdocs

diff --git a/assets/styles/blog.scss b/assets/styles/blog.scss deleted file mode 100644 index a845151..0000000 --- a/assets/styles/blog.scss +++ /dev/null @@ -1,2 +0,0 @@ ---- ---- diff --git a/assets/styles/contact.scss b/assets/styles/contact.scss deleted file mode 100644 index a8faa5d..0000000 --- a/assets/styles/contact.scss +++ /dev/null @@ -1,147 +0,0 @@ ---- ---- - -.title-container h1, .title-container h6 { - width: 550px; - margin: 0 auto; -} - -.full-height { - position: absolute; - top: 0; - left: 0; - right: 0; - bottom: 0; -} - -.contact-container { - background-color: #fff; - display: flex; - flex-direction: column; - justify-content: center; - padding-top: 110px; - padding-bottom: 120px; - min-height: 300px; - .content-title-container { - width: 550px; - margin: 0 auto; - h1, h6 { - font-weight: 300; - } - h1 { - text-align: center; - } - h6 { - padding-top: 10px; - line-height: 145%; - margin: 0 auto; - padding-top: 20px; - padding-left: 10px; - padding-right: 10px; - width: 485px; - width: 90%; - } - .response-time-blurb { - font-size: 12px; - text-align: center; - padding-top: 40px; - padding-bottom: 40px; - } - } - .content-form-container { - width: 650px; - margin: 0 auto; - form { - border: 0; - padding-left: 10px; - padding-right: 10px; - div { - margin-bottom: 60px; - } - select { - border: 0; - border-bottom: 1px solid black; - border-radius: 0; - font-weight: 300; - background: #fff; - font-size: 16px !important; - -webkit-appearance: none; - -moz-appearance: none; - cursor: pointer; - appearance: none; - } - .multiple-text-inputs { - display: flex; - flex-direction: row; - justify-content: space-between; - input { - border: 0; - border-bottom: 1px solid black; - border-radius: 0; - font-weight: 300; - font-size: 16px !important; - } - } - input { - textarea, select { - border: 0; - border-bottom: 1px solid black; - border-radius: 0; - font-weight: 300; - font-size: 16px !important; - } - } - label h6 { - font-weight: 300; - } - textarea { - width: 100%; - height: 100%; - min-height: 70px; - } - input[type="submit"] { - background-color: #fff; - border: 1px solid black; - cursor: pointer; - width: 150px; - float: right; - margin-top: 40px; - height: 30px; - } - } - } -} - -@media screen and (max-width: 850px) { - .content-title-container, .content-title-container h6, .title-container h1, .title-container h6 { - width: 200px !important; - } - .content-form-container { - max-width: 100% !important; - form { - display: flex; - flex-direction: column !important; - } - } - .multiple-text-inputs { - display: flex; - flex-direction: column !important; - } - .content-form-container form div, .multiple-text-inputs input { - margin-bottom: 30px; - } - .contact-title-container h6 { - width: 150px !important; - } -} - -.home-footer { - min-height: 300px; - display: flex; - flex-direction: column; - justify-content: center; - h1 { - font-weight: 300; - text-align: center; - } -} diff --git a/assets/styles/error.scss b/assets/styles/error.scss deleted file mode 100644 index b768484..0000000 --- a/assets/styles/error.scss +++ /dev/null @@ -1,46 +0,0 @@ ---- ---- - -body, html { - display: flex; - height: 100%; - width: 100%; -} - -.error-container { - width: 100%; - height: 100%; - min-height: 100%; - padding-left: 5px; - padding-right: 5px; - position: absolute; - top: 0; - left: 0; - bottom: 0; - right: 0; - .error-content { - height: 100%; - display: flex; - width: 300px; - margin: 0 auto; - justify-content: center; - flex-grow: 1; - flex-direction: column; - h3 { - font-weight: 100; - line-height: 130%; - text-align: center; - padding-top: 30px; - padding-bottom: 30px; - } - } -} - -@media screen and (max-width: 600px) { - .error-container { - .error-content h3 { - font-size: 20px; - width: 300px; - } - } -} diff --git a/assets/styles/home.scss b/assets/styles/home.scss deleted file mode 100644 index 0336af7..0000000 --- a/assets/styles/home.scss +++ /dev/null @@ -1,602 +0,0 @@ ---- ---- - -$headerButtonColour: #8AC60F; - -$iconColour: #CCE0F1; - -$darkerGrayFontColour: #696969; - -$linkColour: #5F9EA0; -$linkColourActive: #20B2AA; - -$lightGray: rgb(236, 236, 236); - -$boxShadow: #A9A9A9; - -$actionButton: #88A6CF; - -$newsletterBackground: #1B2833; - -body { - font-family: 'Roboto', sans-serif; - background-color: #fff; -} - -h1, h2, h3, h4, h5 { - font-family: inherit; -} - -//Home (Stage 1) header -.home-header-s1 { - padding: 1em; - padding-top: 160px; - width: 100%; - min-height: 90vh; - height: 100%; - background: linear-gradient(120deg, #1F3241, #455E6E 70.71%); - display: flex; - flex-direction: column; - justify-content: space-around; - .header-max-width { - width: 600px; - margin: 0 auto; - display: flex; - flex-direction: row; - .header-content { - margin: 0 auto; - color: #fff; - text-align: center; - h3 { - font-weight: 200; - text-align: center; - margin: 0; - padding: 0; - text-transform: uppercase; - } - .intro-par { - font-weight: 200; - margin-top: 20px; - margin-bottom: 40px; - line-height: 24px; - font-size: 16px; - a { - color: #fff; - text-decoration: underline; - transition: 0.5s; - &:hover { - text-decoration: none; - color: lightgray; - transition: 0.5s; - } - } - } - div { - margin-bottom: 40px; - } - div p { - font-weight: 200; - text-align: center; - margin-top: 0; - margin-bottom: 0; - line-height: 24px; - } - div:nth-last-child(2) { - margin-bottom: 10px; - } - div a.view-irc-docs { - margin: 0; - display: inline-block; - text-align: center; - padding: 1em 1.5em; - color: #fff; - border: 1px solid #fff; - font-size: 1em; - transition: 0.3s; - line-height: normal; - border-radius: 0.2em; - &:hover { - text-decoration: underline; - transition: 0.3s; - } - } - div h6 a { - color: #fff; - font-weight: 200; - font-size: 12px; - text-decoration: underline; - transition: 0.5s; - &:hover { - text-decoration: none; - color: lightgray; - transition: 0.5s; - } - } - } - } -} - -//Home (Stage 2) header -.home-header { - padding: 1em; - width: 100%; - position: relative; - min-height: 90vh; - height: 100%; - background: linear-gradient(120deg, #1F3241, #455E6E 70.71%); - display: flex; - flex-direction: column; - justify-content: space-around; - overflow: hidden; - .header-max-width { - max-width: 900px; - margin: 0 auto; - display: flex; - flex-direction: row; - z-index: 4; - .header-content { - width: 50%; - min-width: 300px; - color: #fff; - h2 { - font-weight: 300; - margin: 0; - padding: 0; - display: flex; - flex-direction: column; - align-items: flex-start; - &:first-child { - margin-top: 10px; - } - } - p { - font-weight: 300; - margin-top: 20px; - line-height: 24px; - font-size: 16px; - } - a.launch-chat { - margin: 0; - background-color: $headerButtonColour; - cursor: pointer; - display: inline-block; - text-align: center; - padding: 0.8em 1.1em; - color: #fff; - font-size: 1em; - transition: 0.5s; - font-weight: 400; - border-radius: 0.1em; - &:hover { - text-decoration: none; - color: lightgray; - transition: 0.5s; - } - } - } - } - .header-desktop-image { - z-index: 2; - background-color: $lightGray; - border: 15px solid #000; - border-radius: 20px; - position: absolute; - bottom: -15px; - right: -20px; - height: 500px; - width: 450px; - } - .header-mobile-image { - z-index: 3; - background-color: $lightGray; - border-radius: 30px; - border: 10px solid #000; - position: absolute; - bottom: -30px; - right: 300px; - height: 300px; - width: 220px; - } -} - -@media only screen and (max-width: 1300px) and (orientation: landscape) { - .home-header { - min-height: 400px; - .header-max-width { - padding-top: 20px!important; - } - } -} - -@media screen and (max-width: 1300px) { - .header-max-width { - width: 500px!important; - } - .header-desktop-image { - border-width: 13px!important; - bottom: -13px!important; - right: -120px!important; - height: 350px!important; - } - .header-mobile-image { - border-width: 8px!important; - position: absolute; - bottom: -25px!important; - right: 250px!important; - height: 250px!important; - width: 170px!important; - } -} - -@media screen and (max-width: 1050px) { - .header-desktop-image { - border-width: 10px!important; - bottom: -10px!important; - right: -180px!important; - height: 300px!important; - } - .header-mobile-image { - border-width: 8px!important; - position: absolute; - bottom: -25px!important; - right: 200px!important; - height: 200px!important; - width: 120px!important; - } -} - -@media screen and (max-width: 850px) { - .header-max-width { - width: 300px!important; - } - .header-desktop-image { - right: -230px!important; - } - .header-mobile-image { - right: 140px!important; - } -} - -@media screen and (max-width: 750px) { - .header-desktop-image { - right: -280px!important; - } - .header-mobile-image { - right: 70px!important; - } -} - -@media screen and (max-width: 700px) { - .header-desktop-image { - right: -300px!important; - } -} - -@media screen and (max-width: 675px) { - .home-header { - justify-content: start; - .header-max-width { - padding-top: 70px; - .header-content { - min-height: 665px; - width: 100%; - min-width: 0; - h2 { - margin: auto; - max-width: 90%; - span { - width: 100%; - } - } - p { - font-weight: 300; - font-size: 18px; - margin: 1em auto; - max-width: 90%; - } - a { - margin: 1em auto!important; - } - } - } - .header-desktop-image { - border-width: 10px!important; - bottom: -20px!important; - right: -100px!important; - height: 250px!important; - width: 325px!important; - } - .header-mobile-image { - border-width: 8px!important; - position: absolute; - bottom: -25px!important; - height: 110px!important; - width: 170px!important; - } - } -} - -//App showcase -.home-app-showcase, .home-cta { - min-height: 450px; - .intro { - min-height: 450px; - padding-top: 2em; - padding-bottom: 2em; - display: flex; - flex-direction: column; - justify-content: center; - max-width: 900px; - margin: 0 auto; - h1 { - font-weight: 300; - text-align: center; - } - p { - font-weight: 300; - color: $darkerGrayFontColour; - max-width: 650px; - text-align: center; - margin: 0 auto; - line-height: 26px; - padding-right: 1em; - padding-left: 1em; - } - div { - font-weight: 300; - padding-top: 1em; - font-size: 22px; - text-align: center; - a { - color: $linkColour; - border-bottom: 2px solid $linkColour; - transition: 1s; - &:hover { - color: $linkColourActive; - border-bottom: 2px solid $linkColourActive; - text-decoration: none; - transition: 1s; - } - } - } - } - - .app-examples { - min-height: 300px; - display: flex; - width: 100%; - padding-right: 1em; - padding-left: 1em; - justify-content: center; - flex-direction: column; - .content { - display: flex; - flex-direction: row; - max-width: 1200px; - width: 100%; - margin: 0 auto; - margin-bottom: 10em; - justify-content: space-between; - &.space-around { - justify-content: space-around; - align-items: center; - } - .app-example-content { - max-width: 350px; - width: 35%; - h4, p { - font-weight: 300; - line-height: 26px; - } - .example-blurb { - display: flex; - flex-direction: row; - margin-bottom: 1em; - justify-content: space-between; - position: relative; - i { - display: block; - width: 30%; - color: $iconColour; - } - div { - padding-top: 10px; - font-weight: 300; - width: 70%; - h5 { - font-weight: 500; - padding: 0; - margin: 0; - } - button.example-button { - background-color: $actionButton; - width: 200px; - height: 40px; - border: 0; - border-radius: 2px; - color: #fff; - cursor: pointer; - transition: 0.5s; - &:active { - box-shadow: inset 0 0 10px #000; - } - &:hover { - color: lightgray; - transition: 0.5s; - } - } - } - &:last-child { - justify-content: center; - i { - display: none; - } - button { - margin: 0 auto; - } - } - } - } - .app-example-desktop-view { - width: 750px; - height: 750px; - background-color: $lightGray; - box-shadow: 5px 2.5px 2.5px 1.8px $boxShadow; - border-radius: 10px; - display: flex; - flex-direction: column; - text-align: center; - margin-left: 3em; - justify-content: center; - h1 { - font-weight: 300; - padding: 0; - margin: 0; - } - } - .app-example-mobile-view { - width: 280px; - background-color: $lightGray; - box-shadow: 5px 2.5px 0.5px 1.8px $boxShadow; - height: 550px; - border-radius: 10px; - display: flex; - margin-right: 1em; - flex-direction: column; - text-align: center; - justify-content: center; - h3 { - font-weight: 300; - padding: 0; - margin: 0; - } - } - } - } -} - -@media screen and (max-width: 850px) { - .app-examples { - margin-top: 1em; - padding: 0!important; - .content { - flex-direction: column!important; - .app-example-content { - margin: 0 auto; - width: 90%!important; - } - .app-example-desktop-view { - position: relative!important; - min-height: 330px!important; - margin: 0 auto!important; - width: 100%!important; - margin-top: 1em!important; - margin-bottom: 2em!important; - } - .app-example-mobile-view { - position: relative!important; - // min-height: 330px!important; - margin: 0 auto!important; - order: 2; - margin-top: 1em!important; - margin-bottom: 2em!important; - } - } - } -} - -.home-cta { - display: flex; - flex-direction: column; - justify-content: center; - background-color: $lightGray; - padding-top: 100px; - padding-bottom: 100px; - .intro p { - margin-bottom: 1em; - } -} - -@media screen and (max-width: 850px) { - .home-cta { - div { - min-width: 200px!important; - form { - width: 90%!important; - margin: 0 auto!important; - } - } - } -} - -.home-newsletter { - min-height: 350px; - display: flex; - flex-direction: column; - justify-content: center; - background-color: $newsletterBackground; - color: #fff; - div { - min-width: 250px; - margin: 0 auto; - h1, h6 { - font-weight: 300; - text-align: center; - padding-top: 10px; - } - h6 { - font-size: 12px; - } - form { - display: flex; - justify-content: space-between; - border-bottom: 1px solid #fff; - input { - background-color: transparent; - color: #fff; - border: 0; - width: 100%; - &:nth-child(2) { - font-weight: 300; - width: 30%; - min-width: 150px; - line-height: 50px; - cursor: pointer; - border-top: 1px solid #fff; - border-right: 1px solid #fff; - border-left: 1px solid #fff; - padding-left: 20px; - padding-right: 20px; - transition: 1s; - &:hover { - background-color: gray; - transition: 1s; - } - } - } - } - } -} - -@media screen and (max-width: 850px) { - .home-newsletter { - div { - min-width: 200px!important; - form { - width: 90%!important; - margin: 0 auto!important; - } - } - } -} - -.home-footer { - min-height: 300px; - display: flex; - flex-direction: column; - justify-content: center; - h1 { - font-weight: 300; - text-align: center; - } -} diff --git a/assets/styles/internal_pages.scss b/assets/styles/internal_pages.scss deleted file mode 100644 index ef04da5..0000000 --- a/assets/styles/internal_pages.scss +++ /dev/null @@ -1,291 +0,0 @@ ---- ---- - -// Internal page colour scheme is grey: #dadada -.title-container { - background: linear-gradient(120deg, #1F3241, #455E6E 70.71%); - padding-bottom: 40px; - padding-top: 70px; - display: flex; - margin-top: 72px; - justify-content: center; - flex-direction: column; - color: #fff; - text-align: center; - cursor: default; - h1, h6 { - font-weight: 300; - } - h1 { - text-align: center; - } - h6 { - padding-top: 10px; - line-height: 145%; - max-width: 550px; - margin: 0 auto; - padding-left: 10px; - padding-right: 10px; - max-width: 485px; - } -} - -.s1-contact-container { - color: #fff; - padding: 1em; - padding-top: 160px; - width: 100%; - height: 100%; - background: linear-gradient(120deg, #1F3241, #455E6E 70.71%); - display: flex; - flex-direction: column; - justify-content: center; - cursor: default; - h1, h6 { - font-weight: 300; - text-align: center; - } - h6 { - padding-top: 10px; - line-height: 145%; - width: 550px; - margin: 0 auto; - padding-left: 10px; - padding-right: 10px; - max-width: 485px; - } -} - -@media screen and (max-width: 850px) { - .s1-contact-container h6 { - width: 200px; - } - .title-container { - padding-left: 20px; - padding-right: 20px; - h1 { - font-size: 1.5em; - margin-bottom: 10px; - } - p { - margin-bottom: 0; - } - } -} - -// Contact page -.contact_page_banner { - background-image: none; - background-position: center; - background-size: cover; - background: #dadada; - - .alert { - margin-bottom: 50px; - } - - .call-to-action-block { - h2 i { - margin-bottom: 20px; - margin-right: 0; - } - - .content { - padding: 0 10px 10px 10px; - p { - text-shadow: none; - } - } - - a { - background: transparent; - border: none; - color: #3ec4e4; - text-decoration: underline; - text-shadow: none; - &:hover { - color: #5ddefd; - background: none; - } - } - } -} - -// Newsletter sign up -.newsletter-container { - min-height: 350px; - height: 400px; - display: flex; - flex-direction: column; - justify-content: center; - background-color: #1B2833; - color: #fff; - div { - margin: 0 auto; - h4 { - font-weight: 100; - text-align: center; - padding-top: 10px; - padding-left: 10px; - padding-right: 10px; - margin: 0; - } - h6 { - font-weight: 300; - text-align: center; - padding-top: 10px; - padding-left: 10px; - padding-right: 10px; - font-size: 12px; - } - form { - margin-top: 40px; - display: flex; - justify-content: space-between; - border-bottom: 1px solid #fff; - width: 100%; - input { - background-color: transparent; - color: #fff; - border: 0; - width: 100%; - &:nth-child(2) { - font-weight: 300; - width: 30%; - min-width: 150px; - line-height: 40px; - cursor: pointer; - border-top: 1px solid #fff; - border-right: 1px solid #fff; - border-left: 1px solid #fff; - padding-left: 20px; - padding-right: 20px; - transition: 1s; - &:hover { - background-color: gray; - transition: 1s; - } - } - } - } - } -} - -@media screen and (max-width: 850px) { - .newsletter-container div { - min-width: 300px !important; - form { - margin-bottom: 30px; - margin-top: 30px!important; - width: 90%; - margin: 0 auto!important; - display: flex; - -ms-flex-direction: column; - flex-direction: column; - border-bottom: 0; - input { - display: block; - padding: 5px; - margin: 5px auto; - border-bottom: 1px solid #fff; - width: 90%; - } - } - h6, h4 { - width: 200px !important; - margin: 0 auto; - } - } -} - -// Frequently Asked Questions -.faq-sidebar, .plugin-sidebar { - font-weight: 300; - margin-top: 0.37em; - h4 { - font-size: 1.4em; - font-weight: 300; - margin-bottom: 0.2em; - a { - color: #111; - } - &:not(:first-child) { - margin-top: 1.05em; - } - } - p { - line-height: 1.4; - margin: 0; - + p { - margin-top: 0.5em; - } - } - a { - display: block; - color: #173a60; - &:hover { - text-decoration: none; - } - } -} - -.faq-content, .plugin-content { - h2, h3 { - font-weight: 300; - } - h2:not(:first-child) { - margin-top: 1.8em; - } - h2 + h3 { - margin-top: 0.7em; - } - h3 { - font-size: 1.65em; - margin-top: 1.6em; - color: #3072ba; - a { - color: #3072ba; - &:hover { - text-decoration: none; - } - } - } - h2 a { - color: #111; - &:hover { - text-decoration: none; - } - } - .faqlinker { - position: absolute; - margin-top: -6rem; - } -} - -// Blog updates -.blog-container { - background-color: #fff; - display: flex; - flex-direction: column; - justify-content: center; - .content { - padding-top: 30px; - padding-bottom: 30px; - min-height: 300px; - width: 80%; - margin: 0 auto; - max-width: 900px; - h2, h3, h4 { - font-weight: 100; - margin-top: 1em; - } - p { - font-weight: 100; - margin-top: 1.5em; - } - ul { - font-weight: 100; - margin-top: 0.3em; - } - } -} \ No newline at end of file diff --git a/assets/styles/lets-take-irc-further.scss b/assets/styles/lets-take-irc-further.scss deleted file mode 100644 index 7c4c242..0000000 --- a/assets/styles/lets-take-irc-further.scss +++ /dev/null @@ -1,57 +0,0 @@ ---- ---- - -body { - background: #fbfbfb; - color: #464646; -} - -.letter-page { - font-family: 'Overpass Mono', monospace; - max-width: 55rem; - display: block; - margin: 8rem auto; - background: #fff; - padding: 25px 40px; - box-shadow: 2px 2px 2px rgba(0,0,0,0.1); -} - -.letter-title { - display: block; - width: 100%; - font-size: 0.6em; - padding-bottom: 10px; - margin-bottom: 20px; - border-bottom: 1px solid #888; - text-align: center; - h1 { - font-family: 'Overpass Mono', monospace; - } -} - -ul { - margin: 0 0 20px 0; - li { - list-style-type: lower-roman; - margin: 0 0 0 45px; - cursor: default; - } -} - -@media screen and (max-width: 800px){ - .letter-page { - padding: 20px 10px; - margin: 100px auto 40px auto; - font-size: 1em; - h1 { - font-size: 1.5em; - line-height: 2em; - } - p { - font-size: 0.8em; - } - ul li { - font-size: 0.8em; - } - } -} diff --git a/assets/styles/plugin.scss b/assets/styles/plugin.scss deleted file mode 100644 index ec380ec..0000000 --- a/assets/styles/plugin.scss +++ /dev/null @@ -1,3 +0,0 @@ ---- ---- - diff --git a/assets/styles/social.scss b/assets/styles/social.scss deleted file mode 100644 index 670126c..0000000 --- a/assets/styles/social.scss +++ /dev/null @@ -1,302 +0,0 @@ ---- ---- - -$brandPrimary: #203342; -$brandPrimaryHover: #365165; - -.intro-container { - background: $brandPrimary; - .intro-container-content { - color: #fff; - } -} - -//For your team -.for-your-team { - background: $brandPrimary; - color: #fff; -} - - -//Buttons -.btn { - border-color: $brandPrimary; - background-color: $brandPrimary; - &:hover{ - background-color: $brandPrimaryHover; - } - - &.btn-success { - background: #27a54e; - border-color: #27a54e; - &:hover{ - background-color: #52c776; - } - } - - &.btn-info { - background: #3490b3; - border-color: #3490b3; - &:hover{ - background-color: #52a7c7; - } - } - - &.btn-danger { - background: #b33434; - border-color: #b33434; - &:hover{ - background-color: #ca5252; - } - } -} - -//Custom -a.button { - color: #fff; - border-color: #fff; - &:hover { - background-color: #fff; - color: $brandPrimary; - } - &.button-inverted { - background-color: $brandPrimary; - color: #fff; - &:hover{ - background-color: #fff; - color: $brandPrimary; - } - } -} - - -.documentation { - h1, h2, h3, h4, h5 { - color: $brandPrimary; - } - - p , table, ul{ - code { - color: #ff3f3e; - } - } -} - -//Breadcrumbs -ol.breadcrumb { - background: #fff; -} - -//Intro call to action blocks -.into-call-to-action-block { - h2 { - background: #fff; - color: $brandPrimary; - border-bottom: 1px solid $brandPrimary; - } - p { - background: #fff; - color: #000; - } - a { - color: $brandPrimary; - } -} - -//Course Container -.course-container { - .course { - background: #fff; - .title { - background: $brandPrimary; - color: #fff; - margin: 0; - } - ul.videos{ - width: 100%; - padding: 20px; - background: #fff; - li { - width: 100%; - background: #ebebeb; - a { - color: $brandPrimary; - &.watch { - border: 1px solid $brandPrimary; - &:hover{ - background: $brandPrimary; - color: #fff; - } - } - } - } - } - } -} - -.box-content-container .box-content { - color: #fff; - background-color: $brandPrimary; - margin: 0 0 20px 0; - a { - color: #fff; - text-decoration: underline; - } -} - - -//Full page header -.full-width-page-header { - background-color: $brandPrimary; - color: #fff; -} - -//Example of a sub page -.page-content { - background: #fff; - .sidebar { - background-color: #f7f7f7; - .icon-link { - color: $brandPrimary; - span { - background: $brandPrimary; - color: #fff; - } - &:hover { - color: $brandPrimaryHover; - span { - background-color: $brandPrimaryHover; - } - } - } - - ul a { - color: $brandPrimary; - &:hover { - color: $brandPrimaryHover; - } - } - .sidebar-content-block { - background: $brandPrimary; - color: #fff; - a { - border: 1px solid #fff; - color: #fff; - } - } - } - .main-content .heading { - background-color: #fff; - border-bottom: 1px solid #f1f1f1; - } - .main-content .content { - background-color: #fff; - code { - background: #f1f1f1; - } - pre { - background-color: $brandPrimary; - //(dan): make pre.code because multi-line displays isn't possible otherwise, and I really want that sorta styling - &.code { - background: #f1f1f1; - // line-height: 40px; - display: block; - border-left: 4px solid #007bff; - color: #e83e8c; - padding: 10px 0 10px 20px; - margin: 0 0 20px 0; - pre { - background: none; - } - } - code { - color: #fff; - background: none; - opacity: 0.9; - } - } - } -} - -.news-container .news-post, -.project-container .project-post, -.documentation-latest-container .documentation-post { - background: #fff; - .title a, - .read-more { - color: $brandPrimary; - &:hover { - color: $brandPrimaryHover; - } - } - .project-links li a { - color: $brandPrimary; - &:hover { - color: $brandPrimaryHover; - } - } -} - -.contribute-container { - background-color: $brandPrimary; - color: #fff; - .title { - border-bottom: 1px solid rgba(255,255,255,0.5); - } - .content ul .icon-link { - a { - color: #fff !important; - span { - background-color: #fff; - i { - color: $brandPrimary; - } - } - } - } -} - -//Reusebale Components -.main-content .video-container .content{ - background: #f7f7f7; -} - - -// so the link icons don't take precedence over the actual titles -h1 .fa-link, h2 .fa-link, h3 .fa-link, h4 .fa-link { - opacity: 0.35; -} - -.h1sub { - opacity: 0.65; - font-size: 1.2em; - margin-top: -15px !important; -} - -header .logo .logospecific { - color: #7eaed4; -} -header .logo:hover .logospecific { - color: #007bff; -} - -.alert.experimental { - display: flex; - > .icon { - flex: 0 0 none; - padding-right: 10px; - } - > .description { - flex: 1 1 auto; - } -} - - - -footer { - color: #fff; - - ul li a { - color: #fff; - } -} diff --git a/assets/styles/timeline.scss b/assets/styles/timeline.scss deleted file mode 100644 index 51b303c..0000000 --- a/assets/styles/timeline.scss +++ /dev/null @@ -1,196 +0,0 @@ ---- ---- - -$darkerGrayFontColour: #A9A9A9; -$darkerColour: #2e3d52; - -.timeline-header-container { - min-height: 400px; - background: linear-gradient(120deg, #1F3241, #455E6E 70.71%); - display: flex; - flex-direction: row; - text-align: center; - justify-content: space-around; - padding: 160px 0 77px 0; - .header-content-container { - width: 550px; - display: flex; - flex-direction: column; - justify-content: center; - h1, h6 { - color: #fff; - text-align: center; - font-weight: 300; - } - h6 { - line-height: 1.5em; - padding-left: 5px; - padding-right: 5px; - } - } - - .small-info-content { - max-width: 510px; - padding-left: 5px; - padding-right: 5px; - color: #fff; - display: inline-block; - font-size: 1em; - margin: 0 auto; - padding-top: 40px; - } -} - -.timeline-container { - background-color: #fff; - padding-top: 100px; - padding-bottom: 50px; - width: 100%; - display: flex; - flex-direction: row; - justify-content: space-around; - .timeline-content { - margin: 50px 120px 50px 120px; - border-left: 10px solid $darkerColour; - border-radius: 10px; - position: relative; - color: #fff; - font-weight: 300; - width: 600px; - padding-left: 100px; - padding-right: 20px; - .last-goal { - padding-bottom: 20px; - } - div { - color: $darkerColour; - min-width: 300px; - font-weight: 100; - font-size: 16px; - line-height: 22px; - position: relative; - padding-bottom: 100px; - margin-bottom: 50px; - img { - padding-top: 20px; - padding-bottom: 20px; - } - a { - text-decoration: underline; - font-weight: 600; - color: $darkerGrayFontColour;; - } - h4 { - color: #000; - font-weight: 600; - margin: 0 0 20px 0; - padding: 0; - line-height: 1.5em; - text-align: center; - } - p { - cursor: default; - } - .completed { - font-size: 0.55em; - padding: 10px 15px; - border: 2px solid $darkerColour; - border-radius: 4px; - line-height: normal; - color: $darkerColour; - font-weight: 400; - letter-spacing: 0.5em; - width: 160px; - margin: 0 auto; - margin-top: 20px; - text-align: center; - display: block; - } - } - div:before { - content: ""; - display: block; - width: 55px; - min-height: 10px; - border-top: 5px solid $darkerColour; - border-bottom: 5px solid $darkerColour; - background-color: $darkerColour; - position: absolute; - top: 10px; - left: -105px; - } - div:after { - content: ""; - width: 20px; - height: 20px; - border-radius: 50%; - position: absolute; - top: 5px; - display: block; - left: -60px; - background: $darkerColour; - } - } - .timeline-content:before { - content: ""; - display: block; - width: 10px; - min-height: 30px; - border-top: 20px solid $darkerColour; - position: absolute; - top: -10px; - border-radius: 20px; - left: -10px; - } - .timeline-content:after { - content: ""; - display: block; - width: 10px; - min-height: 30px; - border-bottom: 20px solid $darkerColour; - position: absolute; - bottom: -10px; - border-radius: 20px; - left: -10px; - } -} - -@media screen and (max-width: 700px) { - .timeline-container { - padding-left: 5px; - padding-right: 30px; - .timeline-content { - margin: 0; - padding: 0; - padding-left: 10px; - div { - min-width: 180px; - padding-left: 35px; - padding-right: 5px; - padding-bottom: 30px; - } - div:before { - width: 34px; - left: -11px; - } - div:after { - left: 5px; - width: 20px; - height: 20px; - } - } - } -} - -.home-newsletter { - background: #2a3135; - color: #fff; - padding: 40px 0 10px 0; - h3 { - font-weight: 100; - text-align: center; - a { - text-decoration: underline; - } - } -} diff --git a/contact.html b/contact.html index eab3f53..2550c50 100644 --- a/contact.html +++ b/contact.html @@ -1,5 +1,5 @@ --- -title: Contacting the the IRC Foundation +title: Contact layout: short-header ntitle: Contact nsub: How you can contact us @@ -11,8 +11,7 @@
-

To contact us, visit our IRC channel (#foundation on IRC.com) or our GitHub repo.

-

Otherwise, you may send the Foundation staff an email at foundation@irc.com

+

To contact us, visit our IRC channel (#ircdocs on freenode) or our GitHub repo.

diff --git a/contributing.html b/contributing.html index 1a5881a..3c095aa 100644 --- a/contributing.html +++ b/contributing.html @@ -1,5 +1,5 @@ --- -title: Contributing to the IRC Foundation +title: Contributing layout: short-header ntitle: Contributing nsub: How you can help us out with these documents! @@ -12,7 +12,7 @@

Thanks for thinking about helping us out!

-

There are a number of ways you can help us with the IRC Foundation! We have a contribution document here on our GitHub repo which runs through some of the best ways.

+

There are a number of ways you can help us with this documentation! We have a contribution document here on our GitHub repo which runs through some of the best ways.

diff --git a/guides/irc-dev/index.md b/guides/irc-dev/index.md index 5579448..a1ac7f6 100644 --- a/guides/irc-dev/index.md +++ b/guides/irc-dev/index.md @@ -8,16 +8,10 @@ author: Daniel Oakley series: irc-dev series-page: 0 --- -Welcome to the IRC Foundation developer documentation! +Welcome to the IRC DevDocs! Whether you're new to IRC development or you've been around for decades, thanks for checking out this documentation. We'll do our best to guide your through what we've made here, to other useful documents online, and through to building real software. -First off, what is the IRC Foundation? Well, the Foundation is a group inside IRC.com whose job is supporting IRC projects and developers. While that can take the form of [project funding](/foundation/funding), we're also building up this base of documentation that developers can use and refer back to. Along with this, we're also very intentionally releasing the documentation itself [openly](https://github.com/irccom) so that others can use it and help us build it up. We're always open to new ways of helping IRC developers, so [reach out anytime](/contact) if you have any suggestions! - -Secondly, who are we? Well, the main one writing these guides and this documentation is [Daniel Oakley](https://github.com/DanielOaks), maintainer of ircdocs and Oragono, and contributor to IRCv3. We also have [Darren](https://github.com/prawnsalad), the guy in charge of IRC.com as a whole, as well as maintainer of KiwiIRC and contributor to v3. There's a host of others helping us write the site and help behind the scenes, with more specifics listed [here](#todo). - -So, on to the documentation, and getting into IRC development, itself. - This Intro to IRC Development guide is presented in a few parts, which I'll run through quickly: 1. **Introduction**: This page right here, saying hello and introducing the docs. @@ -32,4 +26,4 @@ This Intro to IRC Development guide is presented in a few parts, which I'll run While there has been an attempt to explain things in order, feel free to skip and jump around sections to find what interests you. Particularly if you've been doing this for a while already. -From myself (Daniel) and the whole IRC.com team, thanks very much for checking out our documentation. Best of luck on your IRC development journey, no matter how deep or shallow you dive into it. +From myself (Daniel) and the whole IRC.com/ircdocs team, thanks very much for checking out our documentation. Best of luck on your IRC development journey, no matter how deep or shallow you dive into it. diff --git a/index.html b/index.html index d26c2af..6f400c0 100644 --- a/index.html +++ b/index.html @@ -1,7 +1,7 @@ --- -title: IRC Foundation Developer Docs +title: Index layout: default -ntitle: Developer Documentation +ntitle: IRC DevDocs nsub: For developers of servers, clients, and everything inbetween --- @@ -10,13 +10,13 @@
-

The IRC Foundation
Protocol Documentation

-

The in-depth documentation for IRC on the web.

-
+

Internet Relay Chat
Protocol Documentation

+

In-depth documentation for IRC on the web.

+

For assistance contact us or learn how to contribute

diff --git a/refs/index.html b/refs/index.html index 6946a3f..e8c0b85 100644 --- a/refs/index.html +++ b/refs/index.html @@ -13,14 +13,14 @@
-

Foundation References

+

DevDocs References

Others

-

Foundation References

+

DevDocs References

Commands

Our Command reference includes information on the commands you can use on IRC servers.

Numerics

diff --git a/tools.html b/tools.html index 2aac12c..598932a 100644 --- a/tools.html +++ b/tools.html @@ -1,5 +1,5 @@ --- -title: IRC Foundation Testing Tools +title: IRC Testing Tools layout: short-header ntitle: Tools nsub: Resources and tools we use to test IRC software @@ -8,25 +8,19 @@
-

Foundation Tools

-

External Tools

+
-

Foundation Tools

-

These are tools that we've written to help us write this documentation.

- -

Docker Images

+

IRC Server Docker Test Images

We host a series of Docker images available here (source here) with different IRC server software running. These images are setup with consistent configurations, oper credentials, and port numbers to speed-up testing.

-

Script Runner

+

Test Script Runner

We've written an IRC script runner available here which makes it simple to run a set of commands and actions across different IRC servers, then output a file for easy comparison between the tested servers.

-

External Tools

-

These are tools written by others in the IRC community, which we also make use of.

-

Parser Tests

The set of test files available here let developers test IRC parsers and uncover areas where they do not parse (particularly complicated or edge-case) messages or incoming lines correctly.