Skip to content

Commit

Permalink
Merge pull request #34 from vv-monsalve/next-prev-readings
Browse files Browse the repository at this point in the history 
Next & Prev readings addition + several formatting and edits
  • Loading branch information
@vv-monsalve
vv-monsalve authored Jun 24, 2022
2 parents a2ae7e4 + c5ce6f5 commit 3f7eab1
Show file tree
Hide file tree
Showing 27 changed files with 523 additions and 206 deletions.
12 changes: 12 additions & 0 deletions gf-guide/authors.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ The <mark class="grey">AUTHORS.txt</mark> file is mandatory for font’s reposit

</div>

<div class="context-reading">
Background reading:<br>
<mark class="green"><b>must&rarr;</b></mark> <a href="./upstream" style="font-weight:bold">Upstream repository structure</a>
</div>

## Table of contents
{:.no_toc}
* TOC goes here
Expand Down Expand Up @@ -67,3 +72,10 @@ You can find a template in [GFPT](https://github.com/googlefonts/googlefonts-pro
Bob Tester <[email protected]>
Maggie Techno <[email protected]>
```

<div class="next-reading">
Further reading:<br>
<mark class="grey">templ</mark> <a href="./license" style="font-weight:bold">License file</a>
<br>
<mark class="green"><b>must&rarr;</b></mark> <a href="./readme" style="font-weight:bold">README file</a>
</div>
37 changes: 24 additions & 13 deletions gf-guide/build.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,12 @@

<div class="callout">

🦕 This chapter aims to guide designers in the building of their font binaries using open-source tools. Everything related to font file settings is detailed in these three chapters:
<ul>
<li><a href="./requirements">Overall font file requirements</a></li>
<li><a href="./statics">Specifics to static fonts</a></li>
<li><a href="./variable">Specifics to variable fonts</a></li>
</ul>

For practicality, the above information won’t be repeated in this chapter. If you read “you should follow the recommendation” or “respect the requirements” etc, please refer to the three chapters above. You will also understand this chapter better if you have read those first.
🦕 This chapter aims to guide designers in the building of their font binaries using open-source tools as per our production requirements. Everything related to font file settings is detailed in the <b>Pre-production</b> part of the guide, and for practicality, that information will not be repeated here.
<br><br>
If you read “you should follow the recommendation” or “respect the requirements” etc, please refer to the chapters labeled as <mark class="blue">start</mark> and <mark class="green"><b>must&rarr;</b></mark> under the Pre-production contents. You will have a better understanding of the following guidelines if you have read them first.
<br><br>
We recommend you install all the tools in a virtual environment, to avoid conflict between packages. Further information is detailed in the Tools and Dependencies section.
<br><br>
We recommend you install all the tools in a virtual environment, to avoid conflict between packages. Further information is detailed in this chapter:
<ul>
<li><a href="./tools">Tools and Dependencies</a></li>
</ul>

For the rest of this chapter, it would be better if you have basic knowledge of:
<ul>
<li>Font tables and font formats</li>
Expand All @@ -29,6 +21,16 @@ For the rest of this chapter, it would be better if you have basic knowledge of:

</div>

<div class="context-reading">
Background reading:<br>
<mark class="blue">start</mark> <a href="./tools" style="font-weight:bold">Tools and Dependencies</a>
<br>
<mark class="green"><b>must&rarr;</b></mark> <a href="https://googlefonts.github.io/gf-guide/index#pre-production-getting-your-fonts-ready-for-gf" style="font-weight:bold">Pre-production: Getting your fonts ready for GF</a> - chapter.
<br>
<mark class="green"><b>must&rarr;</b></mark> <a href="./production" style="font-weight:bold">Production requirements</a>

</div>

## Table of contents
{:.no_toc}
* TOC goes here
Expand Down Expand Up @@ -306,3 +308,12 @@ Unfortunately, the Builder yet can’t do everything. You will have to use a ext
- To hint OTF: use **[AFDKO](https://github.com/adobe-type-tools/afdko)**.
- To subset the font: use **[Fonttools’ subsetter](https://fonttools.readthedocs.io/en/latest/subset/index.html)**.
- If you are using any other font format than `.glyphs` and `.ufo`: the build script should contain a step that converts the sources to UFO. Use **[Fontlab to UFO](https://pypi.org/project/vfb2ufo3/)** or **[FontForge to UFO](https://github.com/fontforge/sfd2ufo)** for example.

<div class="next-reading">
Further reading:<br>
<mark class="green"><b>must&rarr;</b></mark> <a href="./statics" style="font-weight:bold">Static fonts specifics</a>
<br>
<mark class="green"><b>must&rarr;</b></mark> <a href="./metrics" style="font-weight:bold">Vertical metrics</a>
<br>
<mark class="yellow">learn</mark> <a href="./testing">Local testing</a>
</div>
6 changes: 3 additions & 3 deletions gf-guide/culture.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ These are some links where you could find more detailed information about this C

<div class="next-reading">
Further reading:<br>
- <mark class="blue">start</mark> <a href="./required-knowledge" style="font-weight:bold">Knowledge, tools and dependencies required</a>
<mark class="blue">start</mark> <a href="./required-knowledge" style="font-weight:bold">Knowledge, tools and dependencies required</a>
<br>
- <mark class="yellow">learn</mark> <a href="./hosting.md">Hosting projects on Github</a>
<mark class="yellow">learn</mark> <a href="./hosting">Hosting projects on Github</a>
<br>
- <mark class="green"><b>must&rarr;</b></mark> <a href="./upstream" style="font-weight:bold">Upstream repository structure</a>
<mark class="green"><b>must&rarr;</b></mark> <a href="./upstream" style="font-weight:bold">Upstream repository structure</a>
</div>
5 changes: 5 additions & 0 deletions gf-guide/description.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ This file will be created by the team member who will be onboarding the font. Th

</div>

<div class="context-reading">
Background reading:<br>
<mark class="green"><b>must&rarr;</b></mark> <a href="./readmefile" style="font-weight:bold">README file</a>
</div>

## Table of contents
{:.no_toc}
* TOC goes here
Expand Down
16 changes: 13 additions & 3 deletions gf-guide/diacritics.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ This guide will give users an overview introduction to diacritics both from a de

</div>

<div class="context-reading">
Background reading:<br>
<mark class="green"><b>must&rarr;</b></mark> <a href="https://googlefonts.github.io/gf-guide/requirements.html#glyphsets)" style="font-weight:bold">Overall font files requirements/Glyphsets</a>
</div>

## Table of contents
{:.no_toc}
* TOC goes here
Expand Down Expand Up @@ -170,7 +175,7 @@ As stated in the OpenType Specification:

> The `GPOS` table provides precise control over glyph placement for sophisticated text layout and rendering in each script and language system that a font supports.
GPOS table will use the all the X and Y position values of the glyphs for placement operations conditioned by the script and language the font is supporting plus advanced typographic composition tasks as kerning or superscripts.
GPOS table will use all the glyphs' X and Y position values for placement operations conditioned by the script and language the font supports, plus advanced typographic composition tasks such as kerning or superscripts.

From the eight type of positioning actions that the table support, at least two are essential for the functioning of diacritic marks:

Expand Down Expand Up @@ -199,15 +204,15 @@ You could read the entire [GPOS](https://docs.microsoft.com/en-us/typography/ope
<li><a href="http://diacritics.typo.cz/index.php?id=12" target="_blank">Diacritics</a></li>
<li><a href="https://ilovetypography.com/2009/01/24/on-diacritics/" target="_blank">On diacritics</a></li>
<li><a href="http://theinsectsproject.eu/" target="_blank">The insects project</a></li>
<li><a href="https://irenevl.github.io/Polytonic-tutorial/" target="_blank">Polytonic diacritics</a></li>
<li><a href="https://irenevl.github.io/Polytonic-tutorial/" target="_blank">Polytonic Greek: a guide for type designers</a></li>
<li><a href="http://www.twardoch.com/download/polishhowto/intro.html" target="_blank">Polish diacritics how to</a></li>
<li><a href="https://vietnamesetypography.com/tone-marks/" target="_blank">Vietnamese Typography</a></li>
<li><a href="https://www.setuptype.com/x/cod/" target="_blank">Context of Diacritics</a></li>
</ul>
</div>

<div class="column" style="width:50%">
<b>Production related</b>
<b>Production</b>
<ul>
<li><a href="https://glyphsapp.com/learn/mark-to-mark-positioning">Mark to mark positioning Glyphs tutorial</a></li>
<li><a href="https://help.fontlab.com/fontlab-vi/Anchors-and-Pins/">Anchors in Fontlab</a></li>
Expand All @@ -216,3 +221,8 @@ You could read the entire [GPOS](https://docs.microsoft.com/en-us/typography/ope
</ul>
</div>
</div>

<div class="next-reading">
Further reading:<br>
<mark class="yellow">learn</mark> <a href="./outlines">Outline Quality</a>
</div>
16 changes: 15 additions & 1 deletion gf-guide/googlefonts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,17 @@

🦉 <a href="https://github.com/google/fonts">google/fonts</a> is the GitHub repository that is used as a staging area to upload font families to <a href="https://fonts.google.com/">Google Fonts</a>.
<br><br>
The first step to contributing your font to Google Fonts is to submit your contribution as a Pull Request to google/fonts.
Once your project is ready, and you are sure it meets all the font and production requirements; as well as you have located your files in a GitHub repository that follows the required structure, then the definitive step to contributing your font to Google Fonts is to submit it as a Pull Request to google/fonts repository.
<br><br>
This section will help users understand which are the directories, files, and python modules included in the Google/Fonts repository and how they are related.

</div>

<div class="context-reading">
Background reading:<br>
<mark class="green"><b>must&rarr;</b></mark> <a href="./upstream" style="font-weight:bold">Upstream repository structure</a>
</div>

## Table of contents
{:.no_toc}
* TOC goes here
Expand Down Expand Up @@ -109,3 +114,12 @@ As with the axis registry, [the Lang directory](https://github.com/googlefonts/l

- `to_sandbox.txt` is a list of font directories or designer directories to be pushed to sandbox.
- `to_production.txt` is a list of fonts directories or designer directories to be pushed to production. Once the elements (fonts, bio, etc) have been checked and validated in sandbox, they can be sent to the API so users can have access to them. We can only push to production something that was first pushed to sandbox.

<div class="next-reading">
Further reading:<br>
<mark class="brown">team&nbsp;</mark> <a href="./description">Description file</a>
<br>
<mark class="brown">team&nbsp;</mark> <a href="./profile">Designer profile</a>
<br>
<mark class="brown">team&nbsp;</mark> <a href="./metadata">METADATA file</a>
</div>
10 changes: 10 additions & 0 deletions gf-guide/hosting.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ Is one of the various web providers of Git services (Bitbucket, GitLab, to name

</div>

<div class="context-reading">
Background reading:<br>
<mark class="blue">start</mark> <a href="./culture" style="font-weight:bold">Libre Fonts Culture</a>
</div>

## Table of contents
{:.no_toc}
* TOC goes here
Expand Down Expand Up @@ -216,3 +221,8 @@ git config core.ignorecase false
- [Git for type designers by Dave Crossland](https://github.com/davelab6/git-for-type-designers)
- [A short and friendly introduction book to git](https://abookapart.com/products/git-for-humans)
- [Best practices for managing issues](https://blog.zenhub.com/best-practices-for-github-issues/)

<div class="next-reading">
Further reading:<br>
<mark class="green"><b>must&rarr;</b></mark> <a href="./readme" style="font-weight:bold">Upstream repository structure</a>
</div>
13 changes: 13 additions & 0 deletions gf-guide/license-file.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ This page will give users some important requirements about the <mark class="gre

</div>

<div class="context-reading">
Background reading:<br>
<mark class="green"><b>must&rarr;</b></mark> <a href="./upstream" style="font-weight:bold">Upstream repository structure</a>
</div>

## Table of contents
{:.no_toc}
* TOC goes here
Expand Down Expand Up @@ -143,3 +148,11 @@ DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.
```


<div class="next-reading">
Further reading:<br>
- <mark class="grey">templ</mark> <a href="./authors">Authors and Contributors</a>
<br>
- <mark class="green"><b>must&rarr;</b></mark> <a href="./readme" style="font-weight:bold">README file</a>
</div>
9 changes: 9 additions & 0 deletions gf-guide/maintaining.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,15 @@ This guide will help designers to adopt good habits while maintaining their work

</div>

<div class="context-reading">
Background reading:<br>
<mark class="yellow">learn</mark> <a href="./hosting">Hosting projects on Github</a>
<br>
<mark class="green"><b>must&rarr;</b></mark> <a href="./upstream" style="font-weight:bold">Upstream repository structure</a>
<br>
<mark class="green"><b>must&rarr;</b></mark> <a href="https://googlefonts.github.io/gf-guide/onboarding.html#font-upgrades" style="font-weight:bold">Upgrading fonts specifics</a>
</div>

## Table of contents
{:.no_toc}
* TOC goes here
Expand Down
26 changes: 24 additions & 2 deletions gf-guide/making-pr.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,33 @@

🐸 In order to submit a new family or an upgrade of an existing family on <a href="https://fonts.google.com/">fonts.google.com</a>, we must add or update the files held in the <a href="https://github.com/google/fonts">google/fonts</a> repository. This guide will help users submit Pull Requests (PR) which can then be reviewed and merged by a team member.
<br><br>
Before submitting your pull request, make sure you have read the following documentations:

<!-- Before submitting your pull request, make sure you have read the following documentations:
<ul>
<li> <a href="./production">Contributing to GF</a></li>
<li> <a href="./onboarding">Main contribution cases</a></li>
<li> <a href="./requirements">Font files requirements</a></li>
</ul>
</ul>
-->

The PR process requires a good understanding of GitHub and command line tools. If this isn’t you, we suggest simply opening an issue using the <a href="https://github.com/google/fonts/issues/new?assignees=&labels=I+New+Font%2C+II+Submission&template=1_add-font.md&title=Add+%5BFont+Name%5D">Add Font</a> or the <a href="https://github.com/google/fonts/issues/new?assignees=&labels=I+Font+Upgrade&template=2_update-font.md&title=Update+%5BFont+Name%5D">Update Font</a> template in the <a href="https://github.com/google/fonts/issues">issue tracker</a>, and waiting for a team member to ship the font for you.
<br><br>
As a general rule, <b>GF requires users to open an issue before submitting anything through a PR</b>. The PR is the formality that achieve a project, not its starting point. GF uses the issue tracker to define an agenda, generate statistics to estimate the work done, but also to archive decisions. Anything that is going out of GF standards, needs to be documented somewhere, and the issue tracker is here for that purpose. If your font isn’t submitted through an issue first, your PR may never be merged.

</div>

<div class="context-reading">
Background reading:<br>
<mark class="yellow">learn</mark> <a href="./hosting">Hosting projects on Github</a>
<br>
<mark class="blue">start</mark> <a href="./required-knowledge" style="font-weight:bold">Knowledge, tools and dependencies required</a>
<br>
<mark class="green"><b>must&rarr;</b></mark> <a href="./onboarding" style="font-weight:bold">Adding & upgrading fonts to Google Fonts</a>
<br>
<mark class="green"><b>must&rarr;</b></mark> <a href="./requirements" style="font-weight:bold">Overall font files requirements</a>
</div>

## Table of contents
{:.no_toc}
* TOC goes here
Expand Down Expand Up @@ -114,3 +127,12 @@ Now that you have the general scheme in mind, let’s dive into more details. Yo
### Make a PR with the Packager

Good news! Google Fonts also has a tool that packages the font and makes the pull request to google/fonts repo for users with *contributor access* (team members). It uses the SSH protocol, which is why you would need to set up Git with an SSH key if you are a team member. For more info about `gftools packager` and its usage, read [this documentation](package.md).

<div class="next-reading">
Further reading:<br>
<mark class="purple">nerd&nbsp;</mark> <a href="./googlefonts">google/fonts repository explained</a>
<br>
<mark class="brown">team&nbsp;</mark> <a href="./package">Package the fonts</a>
<br>
<mark class="brown">team&nbsp;</mark> <a href="./onboarder-workflow">Onboarder workflow guide</a>
</div>
10 changes: 10 additions & 0 deletions gf-guide/marketing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ In order to tweet about a new release, Google Fonts requires 2-3 expressive imag

</div>

<div class="context-reading">
Background reading:<br>
<mark class="green"><b>must&rarr;</b></mark> <a href="./upstream" style="font-weight:bold">Upstream repository structure</a>
</div>

## Table of contents
{:.no_toc}
* TOC goes here
Expand All @@ -35,3 +40,8 @@ In order to tweet about a new release, Google Fonts requires 2-3 expressive imag
- Link to a mini website if available.

The person onboarding the project will collect images from the documentation directory, include them in a drive folder, write a little tweet according to a simple template, and then it will be reviewed and published when the font is released on the live server.

<div class="next-reading">
Further reading:<br>
<mark class="grey">templ</mark> <a href="./profile">Designer profile</a>
</div>
Loading

0 comments on commit 3f7eab1

Please sign in to comment.