Added assets folder and readme.
This commit is contained in:
parent
8176e74db4
commit
e067449717
29
README.md
Normal file
29
README.md
Normal file
|
@ -0,0 +1,29 @@
|
|||
# Jargonthing
|
||||
This is a project that aims to demistify tech jargon for people who work with developers. Each article should be:
|
||||
- Written in simple, non-technical language.
|
||||
- Self-contained.
|
||||
- Consistently formatted.
|
||||
|
||||
# Why not just use Wikipedia/Google/Official Docs?
|
||||
I'm mostly doing this for fun and am happy to accept that it may be redundant, but I have noticed a few problems with existing resources. Wikipedia articles are usually optimised for technical completness. This often leads to language that even people reasonably well aquainted with the concepts being discussed struggle to understand completely. [Simple Wikipedia](simple.wikipedia.org) is an improvement, but nowhere near as complete. Official documentation for a project is almost always aimed at a technical audience.
|
||||
|
||||
I'm hoping to encourage other developers to contribute to this by building it using tools that a developer audience feel comfortable with, namely [Jekyll](https://jekyll.org) and [GitHub](https://github.com).
|
||||
|
||||
# Contributing
|
||||
There aren't that many conventions set in stone yet. I created a bash script to scaffold out a new topic page:
|
||||
```
|
||||
./new_topic.sh [unique file name] [descriptive name]
|
||||
```
|
||||
E.g.:
|
||||
```
|
||||
./new_topic.sh dotnet-framework '.NET Framework'
|
||||
```
|
||||
|
||||
There are a few common sub-headings that you can choose to use when writing a topic, namely things like:
|
||||
- Examples. Lean towards things that a non-developer might find useful instead of lines of code.
|
||||
- Similar to. Technologies or ideas that are comparable to what is being discussed. An article about React might list things like Vue.JS or Knockout as being similar.
|
||||
- Differs to. Technologies or ideas that are antithesis to what is being discussed. Bit more difficult this one, but I used it for Library vs. Framework for example.
|
||||
- Prequisite Knowledge. Technologies or ideas that one would need to have a level of understanding of in order to use the thing being discussed. React might list JavaScript for example.
|
||||
- Also known as. Similies for the topic. An article on 'Node.JS' might list 'Node'.
|
||||
|
||||
Don't write things that aren't necessary for a non-technical person to grasp the topic. This is in no way meant to replace official documentation, Wikipedia or Stack Overflow.
|
|
@ -7,12 +7,10 @@
|
|||
<div class="collapse navbar-collapse" id="navbarSupportedContent">
|
||||
<ul class="navbar-nav mr-auto">
|
||||
</ul>
|
||||
{% if !page.hide_search %}
|
||||
<form class="form-inline my-2 my-lg-0">
|
||||
<input class="form-control mr-sm-2" type="search" placeholder="Search" aria-label="Search">
|
||||
<button class="btn btn-outline-light my-2 my-sm-0" type="submit">Search</button>
|
||||
</form>
|
||||
{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
|
@ -6,7 +6,7 @@
|
|||
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
|
||||
|
||||
<!-- Bootstrap CSS -->
|
||||
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.1/css/bootstrap.min.css" integrity="sha384-WskhaSGFgHYWDcbwN70/dfYBj47jz9qbsMId/iRN3ewGhXQFZCSftd1LZCfmhktB" crossorigin="anonymous">
|
||||
<link rel="stylesheet" href="assets/bootstrap.min.css" integrity="sha384-WskhaSGFgHYWDcbwN70/dfYBj47jz9qbsMId/iRN3ewGhXQFZCSftd1LZCfmhktB" crossorigin="anonymous">
|
||||
|
||||
<title>{{ site.title }}</title>
|
||||
</head>
|
||||
|
@ -17,10 +17,17 @@
|
|||
|
||||
{{ content }}
|
||||
|
||||
<hr />
|
||||
<div class='container'>
|
||||
<p>
|
||||
Contribute on <a target='_blank' href='https://github.com/mistakenot'>GitHub</a>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<!-- Optional JavaScript -->
|
||||
<!-- jQuery first, then Popper.js, then Bootstrap JS -->
|
||||
<script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script>
|
||||
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.1/js/bootstrap.min.js" integrity="sha384-smHYKdLADwkXOn1EmN1qk/HfnUcbVRZyYmZ4qpPea6sjB/pTJ0euyQp0Mk8ck+5T" crossorigin="anonymous"></script>
|
||||
<script src="assets/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
|
||||
<script src="assets/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script>
|
||||
<script src="assets/bootstrap.min.js" integrity="sha384-smHYKdLADwkXOn1EmN1qk/HfnUcbVRZyYmZ4qpPea6sjB/pTJ0euyQp0Mk8ck+5T" crossorigin="anonymous"></script>
|
||||
</body>
|
||||
</html>
|
9
_topic/angularjs.markdown
Normal file
9
_topic/angularjs.markdown
Normal file
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
layout: topic
|
||||
title: "Angular.JS"
|
||||
---
|
||||
|
||||
# Angular.JS
|
||||
|
||||
This topic is awaiting content. Open a pull request to contribute!
|
||||
|
7
_topic/authorization.markdown
Normal file
7
_topic/authorization.markdown
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
layout: topic
|
||||
title: "Authorization"
|
||||
---
|
||||
|
||||
# Authorization
|
||||
|
7
_topic/browser.markdown
Normal file
7
_topic/browser.markdown
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
layout: topic
|
||||
title: "Web Browser"
|
||||
---
|
||||
|
||||
# Web Browser
|
||||
|
13
_topic/client-server.markdown
Normal file
13
_topic/client-server.markdown
Normal file
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
layout: topic
|
||||
title: "Client-Server"
|
||||
---
|
||||
|
||||
# Client-Server
|
||||
|
||||
'Client-Server' is a model for communication between two computer systems. The role of the Server is to receive requests and act upon them, by either returning or modifying data. The role of the Client is to create and send these requests to the Server, often on behalf of a human user.
|
||||
|
||||
The Server is usually responsible for securing access to sensitive data and ensuring that all requests from Clients are properly [authorized](authorization) and validated. The Client is usually responsible for receiving input directly from a user in the form of mouse clicks or keyboard typing and formatting this data into a form that the Server can understand.
|
||||
|
||||
### Examples
|
||||
In a [Web Application](web-application) that allows a user to book hotel reservations, the Client would be represented by the users [Web Browser](browser). The Client would create a request to book a hotel on behalf of the user and send this to a Server. If the request made by the Client is valid, the Server would create a new reservation.
|
7
_topic/desktop-application.markdown
Normal file
7
_topic/desktop-application.markdown
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
layout: topic
|
||||
title: "Desktop Application"
|
||||
---
|
||||
|
||||
# Desktop Application
|
||||
|
9
_topic/dotnet-core.markdown
Normal file
9
_topic/dotnet-core.markdown
Normal file
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
layout: topic
|
||||
title: ".NET Core"
|
||||
---
|
||||
|
||||
# .NET Core
|
||||
|
||||
This topic is awaiting content. Open a pull request to contribute!
|
||||
|
11
_topic/dotnet-framework.markdown
Normal file
11
_topic/dotnet-framework.markdown
Normal file
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
layout: topic
|
||||
title: ".NET Framework"
|
||||
---
|
||||
|
||||
# .NET Framework
|
||||
|
||||
The .NET Framework is a [software framework](framework) that was originally designed and released by [Microsoft](microsoft) in 2001. It originally could be used to build [desktop applications](desktop-application) for the [Windows](windows) operating system but has since expanded to be used to build [server-side](client-server) [web](web-application) and [mobile](mobile-application) applications.
|
||||
|
||||
|
||||
|
4
_topic/file.markdown
Normal file
4
_topic/file.markdown
Normal file
|
@ -0,0 +1,4 @@
|
|||
---
|
||||
layout: topic
|
||||
title: "your_title"
|
||||
---
|
|
@ -1,4 +1,15 @@
|
|||
---
|
||||
layout: post
|
||||
layout: topic
|
||||
title: "Software Framework"
|
||||
---
|
||||
---
|
||||
|
||||
# Software Framework
|
||||
|
||||
A Software Framework is a set of tools, libraries and methodologies that are designed to make it easier for [developers](developer) to build systems. Frameworks differ from [libraries](library) in that they often expect the developers using them to follow certain patterns and methodologies when using them.
|
||||
|
||||
#### Examples
|
||||
- [.NET Framework](dotnet-framework)
|
||||
- [Ruby on Rails](ruby-on-rails)
|
||||
|
||||
#### Differs to
|
||||
- [Software Libraries](library)
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: post
|
||||
layout: topic
|
||||
title: "JavaScript"
|
||||
---
|
||||
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
---
|
||||
layout: post
|
||||
layout: topic
|
||||
title: "Software Library"
|
||||
---
|
||||
|
||||
# Software Library
|
||||
|
||||
A library is a small collection of software components that are designed to be used in a larger system. The components in a library usually share a single cohesive theme and do not try to dictate how they should be used by other systems.
|
||||
A Software Library is a small collection of components that are designed to be used as part of a larger system. The components in a library usually share a single cohesive theme and do not try to dictate how they should be used by other systems.
|
||||
|
||||
#### Differs to
|
||||
- [Software Framework](framework)
|
7
_topic/microsoft.markdown
Normal file
7
_topic/microsoft.markdown
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
layout: topic
|
||||
title: "Microsoft"
|
||||
---
|
||||
|
||||
# Microsoft
|
||||
|
7
_topic/mobile-application.markdown
Normal file
7
_topic/mobile-application.markdown
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
layout: topic
|
||||
title: "Mobile Application"
|
||||
---
|
||||
|
||||
# Mobile Application
|
||||
|
9
_topic/nodejs.markdown
Normal file
9
_topic/nodejs.markdown
Normal file
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
layout: topic
|
||||
title: "Node.JS"
|
||||
---
|
||||
|
||||
# Node.JS
|
||||
|
||||
This topic is awaiting content. Open a pull request to contribute!
|
||||
|
9
_topic/npm.markdown
Normal file
9
_topic/npm.markdown
Normal file
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
layout: topic
|
||||
title: "NPM"
|
||||
---
|
||||
|
||||
# NPM
|
||||
|
||||
This topic is awaiting content. Open a pull request to contribute!
|
||||
|
9
_topic/package-manager.markdown
Normal file
9
_topic/package-manager.markdown
Normal file
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
layout: topic
|
||||
title: "Package Manager"
|
||||
---
|
||||
|
||||
# Package Manager
|
||||
|
||||
This topic is awaiting content. Open a pull request to contribute!
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
layout: post
|
||||
layout: topic
|
||||
title: "React.JS"
|
||||
---
|
||||
|
||||
|
|
7
_topic/web-application.markdown
Normal file
7
_topic/web-application.markdown
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
layout: topic
|
||||
title: "Web Application"
|
||||
---
|
||||
|
||||
# Web Applications
|
||||
|
7
_topic/windows.markdown
Normal file
7
_topic/windows.markdown
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
layout: topic
|
||||
title: "Windows"
|
||||
---
|
||||
|
||||
# Windows
|
||||
|
7
assets/bootstrap.min.css
vendored
Normal file
7
assets/bootstrap.min.css
vendored
Normal file
File diff suppressed because one or more lines are too long
7
assets/bootstrap.min.js
vendored
Normal file
7
assets/bootstrap.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
2
assets/jquery-3.3.1.slim.min.js
vendored
Normal file
2
assets/jquery-3.3.1.slim.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
5
assets/popper.min.js
vendored
Normal file
5
assets/popper.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
|
@ -28,13 +28,9 @@ hide_search: true
|
|||
|
||||
<div class='row'>
|
||||
<div class='col'>
|
||||
<div class='d-flex flex-row justify-content-around flex-wrap'>
|
||||
<div class='d-flex flex-row justify-content-around flex-wrap h4'>
|
||||
{% for item in site.topic %}
|
||||
<span class='badge badge-primary text-light' style='margin: 4px;'>
|
||||
<a href="{{ item.url }}">
|
||||
<span class='text-light'>{{ item.title }}</span>
|
||||
</a>
|
||||
</span>
|
||||
<a class='badge badge-primary' href="{{ item.url }}" style='margin: 5px;'>{{ item.title }}</a>
|
||||
{% endfor %}
|
||||
</div>
|
||||
</div>
|
||||
|
|
9
new_topic.sh
Executable file
9
new_topic.sh
Executable file
|
@ -0,0 +1,9 @@
|
|||
echo '---
|
||||
layout: topic
|
||||
title: "'$(echo $2)'"
|
||||
---
|
||||
|
||||
# '$(echo $2)'
|
||||
|
||||
This topic is awaiting content. Open a pull request to contribute!
|
||||
' >> ./_topic/$1.markdown
|
Loading…
Reference in a new issue