Skip to content

Commit ec9b283

Browse files
author
Phil Hawksworth
committed
more consice summaries for meta and og
1 parent 743dfc9 commit ec9b283

File tree

4 files changed

+25
-6
lines changed

4 files changed

+25
-6
lines changed

netlify.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@
3737

3838
[[redirects]]
3939
from = "/img/og/glossary/:term/:summary"
40-
to = "https://res.cloudinary.com/netlify/image/fetch/l_text:Roboto_65_bold::term,co_rgb:FFFFFF,g_north_west,y_128,x_88/l_text:Roboto_34_light::summary,co_rgb:FFFFFF,g_north_west,y_245,x_149/https://jamstack.org/img/og/glossary-card-bg.png"
41-
status = 302
40+
to = "https://res.cloudinary.com/netlify/image/fetch/l_text:Roboto_65_bold::term,co_rgb:FFFFFF,g_north_west,y_75,x_100/l_text:Roboto_34_light::summary,co_rgb:FFFFFF,g_north_west,y_200,x_160/https://jamstack.org/img/og/glossary-card-bg.png"
41+
status = 200
4242

4343
[[redirects]]
4444
from = "/glossary/*"

src/site/_data/glossary.yaml

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,36 @@
1+
2+
# Summary and term values are used in both the page meta tags and also the auto generated
3+
# open graph and twitter card images. Those 2 fields should not exceed the following character counts:
4+
# term: 30
5+
# summary: 250
6+
17
- term: 'Atomic deploys'
28
id: 'atomic'
9+
summary: 'Contained and complete deploys, which begin being served only when all of their assets and config are complete and totally in place.'
310
definition: 'The word "atomic" is used to describe deploys which include no interim state or maintenance window. With atomic deploys, all of the code, assets and configuration of a site are updated at once so that a website cannot be be served in a partially updated state.
411
512
6-
While deploying and updating sites via FTP was once popular this would result in some updated files being present on the server and ready to serve while others were still in transit. Modern platforms avoid this situation by providing atomic deploys where the new version of the site only begins receiving request when all assets and configurations are available. See also [Immutable builds](/glossary/immutable).'
13+
While deploying and updating sites via FTP was once popular this would result in some updated files being present on the server and ready to serve while others were still in transit. Modern platforms avoid this situation by providing atomic deploys where the new version of the site only begins receiving request when all assets and configurations are available. See also [Immutable deploys](/glossary/immutable).'
714

815
- term: 'Immutable deploys'
916
id: 'immutable'
10-
definition: 'While a "mutable" item can change (be mutated) over time, an "immutable" item cannot. Once created, an immutable build of a website becomes an artefact which will not change. Instead, deploys result in new versions or instances of the site, and traffic is routed to them accordingly.
17+
summary: 'Once created, an immutable deploy of a website becomes an artifact which will not change. It is a known version of the site which can be redeployed with ease.'
18+
definition: 'While a "mutable" item can change (be mutated) over time, an "immutable" item cannot. Once created, an immutable deploy of a website becomes an artifact which will not change. Instead, deploys result in new versions or instances of the site, and traffic is routed to them accordingly.
1119
1220
1321
When paired with [atomic deploys](/glossary/atomic), immutable builds make it possible for sites to enjoy abilities such as instant rollbacks and versioning, and help to ensure that the code and assets of a website can be maintained in a known state.'
1422

1523

1624
- term: 'CDN (Content Delivery Network)'
1725
id: 'cdn'
26+
summary: 'A network of optimized for serving assets to users. A CDN can provide redundancy and also improve delivery performance as a result of being geographically distributed.'
1827
definition: 'A distributed network optimized for serving assets to users. By being geographically distributed, a CDN can provide redundancy and also improve delivery performance as a result of servicing requests from the infrastructure closest to the user making the request.'
1928

2029
- term: 'Edge Network'
2130
id: 'edge-network'
2231

2332
- term: 'Serverless'
33+
summary: 'Serverless functions are a means of providing a run-time environment for code without the need for knowledge of, or control over, the underlying environment.'
2434
definition: '"Serverless" or "serverless functions" are a means of providing a run-time environment for code without the need for knowledge of, or control over, the underlying environment. [It allows event-driven logic on the server without setting up infrastructure](https://twitter.com/sarah_edo/status/1361692489384517634).
2535
2636
@@ -29,44 +39,53 @@
2939

3040
- term: 'Pre-render / Pre-generate'
3141
id: 'pre-render'
42+
summary: 'To generate the markup which represents a view of in advance of when it is required instead of just-in-time in response to requests.'
3243
definition: 'To generate the markup which represents a view in advance of when it is required. This happens during a build rather than on-demand so that web servers do not need to perform this activity for each request recieved.'
3344

3445
- term: 'Server render'
3546
id: 'server-render'
47+
summary: 'To generate markup on the server rather than on the client. Server render usually refers to the process happening at request time, rather than in advance at build time.'
3648
definition: 'To generate markup on the server rather than on the client. Server render usually refers to the process happening at request time, rather than at build time. Some do use this term as a catch all for any rendering taking place on a server, and so disambiguation is often sensible.'
3749

3850
- term: 'Static site generator'
3951
id: 'ssg'
52+
summary: 'A tool which can transform content, data, and templates into files that can be deployed to a hosting environment as a ready-to-serve web site.'
4053
definition: "A tool which can be run as part of a build to transform content, data, and templates into files which can be deployed to a hosting environment as a ready-to-serve web site. Find a more detailed description in this article: <a href='https://www.netlify.com/blog/2020/04/14/what-is-a-static-site-generator-and-3-ways-to-find-the-best-one/?utm_source=jamstackorg&utm_medium=what-are-ssg-pnh&utm_campaign=devex'>What is a Static Site Generator? And 3 ways to find the best one</a>."
4154

4255
- term: 'Headless technology'
4356
id: 'headless-technology'
57+
summary: 'Often referring to decoupled content management systems, headless tools have no responsibility for generating the view or presentation of content, but instead focus on the management of and access to content via APIs.'
4458
definition: 'The term "headless" refers to removing the dependency of knowing where data will be displayed and instead just holding the data to be used wherever the developer chooses. This is often used to describe a CMS where content can be entered, held, then where and how that content is displayed is decided separately.'
4559

4660
- term: 'Client render'
4761
id: 'client-render'
62+
summary: 'To generate the view of content, or update user interface elements, in the browser using JavaScript.'
4863
definition: 'To generate the view of content in the browser using JavaScript. This often involves transmitting data to the browser rather than markup which is ready for the browser to display, and then using JavaScript to transform that data into a view by modifying the DOM'
4964

5065
- term: 'Hydration'
5166
id: 'hydration'
5267

5368
- term: 'Decoupling'
5469
id: 'decoupling'
70+
summary: 'Creating a distinct separation between systems or services. By decoupling the services needed to operate a site, each component part can be more easily swapped out, upgraded, and understood.'
5571
definition: 'Decoupling is the process of creating a clean separation between systems or services. By decoupling the services needed to operate a site, each component part can become easier to reason about, can be independently swapped out or upgraded, and can be designated the purview of dedicated specialists either within an organization, or as a third party.'
5672

5773
- term: 'Dynamic server'
5874
id: 'dynamic-server'
5975

6076
- term: 'API'
6177
id: 'api'
78+
summary: 'API is the acronym for Application Programming Interface. It defines interactions that allows two applications to talk to each other.'
6279
definition: 'API is the acronym for Application Programming Interface. It defines interactions that allows two applications to talk to each other.'
6380

6481
- term: 'API Economy'
6582
id: 'api-economy'
83+
summary: 'A term that has come to mean the depth and breadth of APIs that are available for developers to use in the current landscape.'
6684
definition: 'A term that has come to mean the depth and breadth of APIs that are available for developers to use in the current landscape.'
6785

6886
- term: 'Microservice'
6987
id: 'microservice'
88+
summary: 'A programming paradigm where many parts of a large application are broken down into various units that have smaller responsibility.'
7089
definition: 'A programming paradigm where many parts of a large application are broken down into various units that have smaller responsibility. We can use Serverless or APIs for this, but it''s not that APIs or Serverless are necessarily Microservices, it''s that we have split apart what we want to access, and that modularity is what we call Microservices.'
7190

7291
- term: 'Monolith'

src/site/glossary-pages.njk

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ layout: layouts/base.njk
99

1010
eleventyComputed:
1111
title: "{{ item.term }}"
12-
description: "What is {{ item.term }}? {{ item.definition }}"
13-
ogimage: "/img/og/glossary/{{ item.term }}/{{ item.definition }}"
12+
description: "What is {{ item.term }}? {{ item.summary }}"
13+
ogimage: "/img/og/glossary/{{ item.term }}/{{ item.summary }}"
1414

1515
---
1616

11.7 KB
Loading

0 commit comments

Comments
 (0)