diff --git a/README.md b/README.md index 92ee70cf72c9d65243e504adc716f7217e7a4e0a..163d0045b22fdf6b3b3fb74bb3c2f494a41fb42f 100644 --- a/README.md +++ b/README.md @@ -1 +1 @@ -# CodeChina Explore \ No newline at end of file +# CodeChina Explore diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000000000000000000000000000000000..bfefa338dcfa9b364c0f2342f1d5336ca91ef575 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,61 @@ +## Making edits to a topic + +If you're making edits to a topic page, the following fields are available for use. Not all fields are required. + +### topic +(required) Name of the topic, which will be used in the URL, e.g. `https://codechina.net/topics/[URL]`. Formatted as lowercase. + +Acceptable formatting: + +* Starts with a letter or number +* Contains only letters, numbers, and hyphens +* At most 35 characters long + +### display_name +(required) The topic name that will be displayed on the topic page (ex. `React`). Should use proper noun capitalization. Emoji are not allowed. + +### description +(required) A short description of the topic, which will be used on the Explore homepage, Topics subpage, and other preview areas. Must be 130 characters or less. Emoji are not allowed. + +### selected +(required) Set topic to selection topics, default false. + +### aliases +(if applicable) Synonyms for the topic name. For example, `react` and `reactjs` are aliases. You +should only list an alias for your topic if the majority of repositories using that alias are +referring to the same subject matter as the topic. You should not list another topic as an alias +if the alias is a superset of your topic. + +For example, `api` makes sense in the `related` field for the `graphql` topic, but because many +repositories tagged with `api` are _not_ be associated with `graphql`, `api` does not make sense +in the `aliases` field for `graphql`. + +Each alias must be formatted like that topic's `topic` field (same as the URL slug). Acceptable formatting: + +* Starts with a letter or number +* Contains only letters, numbers, and hyphens +* At most 35 characters long + +### logo +(if applicable) The official logo url associated with that topic. You must have permission to use this logo. If no official logo exists, do not include an image url. + +### website +(if applicable) URL to the topic's official website + +### blog +(if applicable) URL to the topic's blog website + +## example + +```yaml +--- +topic: ruby +aliases: 'ruby on rails, rails, ror' +display_name: Ruby +website: 'http://rubyonrails.com' +description: 'Ruby is a scripting language designed for simplified object-oriented programming.' +blog: 'http://rubychina.com' +logo: 'https://github.com/github/explore/blob/master/topics/ruby/ruby.png?raw=true' +selected: true +--- +``` diff --git a/topics/bootstrap/index.yml b/topics/bootstrap/index.yml index a643acd73c2f5ded6104139028ed74de9a81ac96..42da63be87a7281be04d99e891ba076e1a594429 100644 --- a/topics/bootstrap/index.yml +++ b/topics/bootstrap/index.yml @@ -5,4 +5,5 @@ display_name: 'Bootstrap' website: 'https://github.com/twbs' description: 'Bootstrap is an HTML, CSS, and JavaScript framework.' selected: true +logo: 'https://github.com/github/explore/blob/master/topics/bootstrap/bootstrap.png?raw=true' --- \ No newline at end of file diff --git a/topics/html/index.yml b/topics/html/index.yml index 46edb9fc50daa5d7b70ab09b2fbee86e6d107bb5..1227a8a682ce82d4ff09092d50c7e6353bb94392 100644 --- a/topics/html/index.yml +++ b/topics/html/index.yml @@ -3,7 +3,7 @@ display_name: Html topic: html selected: true aliases: 'html' -description: 'html is a general purpose and object-oriented programming language.' -website: 'https://isocpp.org/' +description: 'HTML is the fundamental markup language for webpages.' +website: 'https://www.w3.org/html/' logo: 'https://github.com/github/explore/blob/master/topics/html/html.png?raw=true' --- diff --git a/topics/js/index.yml b/topics/js/index.yml new file mode 100644 index 0000000000000000000000000000000000000000..8a6b78a9296433f03bdf8f1480b47fb5d491c246 --- /dev/null +++ b/topics/js/index.yml @@ -0,0 +1,10 @@ +--- +topic: js +display_name: JavaScript +aliases: 'javascript' +selected: true +website: 'http://www.javascript.com' +description: 'JavaScript (JS) is a lightweight interpreted programming language with first-class functions.' +blog: 'http://blog.js.com' +logo: 'https://github.com/github/explore/blob/master/topics/javascript/javascript.png?raw=true' +--- diff --git a/topics/ruby/index.yml b/topics/ruby/index.yml index 5ecb72530afea7ba8db2275029f87bcc8e4c98a2..521fc711973175ace3c7f1b7b462e4ff1f0ab864 100644 --- a/topics/ruby/index.yml +++ b/topics/ruby/index.yml @@ -7,5 +7,4 @@ description: 'Ruby is a scripting language designed for simplified object-orient blog: 'http://rubychina.com' logo: 'https://github.com/github/explore/blob/master/topics/ruby/ruby.png?raw=true' selected: true -hello: world ---