Skip to content
This repository has been archived by the owner on Oct 26, 2021. It is now read-only.

Mention Templates in KLC G section #419

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/blog/kicon-announcement.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ ideas and get to know other users and members of the development team.
Attendees can expect to receive an excellent badge and some nifty swag.

If you are interested in sponsoring the event, please go to the
https://kicad-kicon.com/sponsors/[sponsors page] to donate. If you are
https://2019.kicad-kicon.com/sponsors/[sponsors page] to donate. If you are
interested in volunteering please go to the
https://docs.google.com/forms/d/e/1FAIpQLSdI5k4_8tfl8UaIDghO6lezD_QGg3pLlAUlTdlluOfQuST9dA/viewform[volunteers page]
to sign up. Any help is greatly appreciated. Don't forget to thank all
Expand Down
2 changes: 1 addition & 1 deletion content/contribute/docs-team.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ documenters and users in the channel.
Most of the action takes place on two repositories on GitHub.

- link:https://github.com/KiCad/kicad-doc[Official Documentation]
- link:https://github.com/KiCad/kicad-website[Website]
- link:https://gitlab.com/kicad/services/kicad-website[Website]

What are the tasks we are working on?

Expand Down
2 changes: 1 addition & 1 deletion content/help/report-an-issue.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ docs.kicad-pcb.org. Please report any issues in the correct location.



link:https://github.com/KiCad/kicad-website/issues[I have a kicad-pcb.org issue^,role="btn btn-default btn-primary"]
link:https://gitlab.com/kicad/services/kicad-website/issues[I have a kicad-pcb.org issue^,role="btn btn-default btn-primary"]


link:https://gitlab.com/kicad/services/kicad-doc-website/-/issues[I have a docs.kicad-pcb.org issue^,role="btn btn-default btn-primary"]
Expand Down
7 changes: 4 additions & 3 deletions content/help/system-requirements.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,9 @@ The software prerequisites for installing on a macOS system are as follows:
|===
|Operating System | End of Support
|macOS 10.12 | Unsupported
|macOS 10.13 | 1-Aug-2020
|macOS 10.13 | Unsupported
|macOS 10.14 | 1-Aug-2021
|macOS 10.15 | 1-Aug-2022
|===

[%hardbreaks]
Expand All @@ -101,7 +102,7 @@ on some of the older distributions listed below.
|Ubuntu 18.04 (LTS) |1-Apr-2021
|Ubuntu 18.10 |Unsupported, will most likely still function
|Ubuntu 19.04 |Unsupported, will most likely still function
|Ubuntu 19.10 |1-July-2020
|Ubuntu 19.10 |Unsupported, will most likely still function
|Ubuntu 20.04 (LTS) |approx May 2023
|===

Expand All @@ -118,7 +119,7 @@ is under https://wiki.ubuntu.com/Releases[standard support] from Ubuntu.
|===
|Operating System |End of Support
|Fedora 29 |Unsupported, will most likely still function
|Fedora 30 |approx May 2020
|Fedora 30 |Unsupported, will most likely still function
|Fedora 31 |approx November 2020
|Fedora 32 |approx May 2021
|===
Expand Down
2 changes: 1 addition & 1 deletion content/klc/G1.1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
brief = "Only standard characters are used for naming libraries and components"
+++

Filenames, symbol names, footprint names and model names must contain only valid characters, as determined below:
Filenames, symbol names, footprint names, model names, 3D model names, and template names must contain only valid characters, as determined below:

. Alphanumeric characters (`A-Z`, `a-z`, `0-9`)
. Underscore `_`
Expand Down
1 change: 0 additions & 1 deletion content/klc/G1.5.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,3 @@ In general, plural naming (e.g. for libraries) should be avoided, as pluralisati
* `Sensor_Temperature` instead of `Sensors_Temperature`
* `Memory_Flash` instead of `Memories_Flash`
* `TerminalBlock` instead of `TerminalBlocks`

2 changes: 1 addition & 1 deletion content/libraries/klc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ __Note: While many of the KLC guidelines are checked by these scripts, there are

== General Library Guidelines

The general library guidelines apply to all library elements (symbols / footprints / models). However, these guidelines may be overridden in some cases by specific exceptions described in further sections.
The general library guidelines apply to all library elements (symbols / footprints / models / templates / 3D models). However, these guidelines may be overridden in some cases by specific exceptions described in further sections.

{{< klc_list title="General Guidelines" filter="G1.">}}

Expand Down
3 changes: 3 additions & 0 deletions content/libraries/klc_history.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ summary = "Revision history of the KiCad Library Conventions"
+++

---
== 3.0.27 - 2020-09-12
* Change general guidelines (G) to mention templates and 3D models

== 3.0.26 - 2020-01-18
* Clarify that contributions must be made with the current stable version (G1.8)

Expand Down
4 changes: 2 additions & 2 deletions content/made-with-kicad/submit-a-project.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ patches on behalf of a company), the developers with contribution history

== Submission Process

. Fork the https://github.com/KiCad/kicad-website repository on GitHub
. Fork the https://gitlab.com/kicad/services/kicad-website repository on GitHub
. Add a new folder in your fork under the `/content/made-with-kicad/` folder such as `/content/made-with-kicad/my-project-a/`
. Create a index.adoc in the newly created folder with the following template as a base
+
Expand Down Expand Up @@ -69,4 +69,4 @@ My project is totally cool and awesome
. Create a image for the project. It should be in either `png` or `jpg` format and no larger than `800x600` in size. Add the image to the same folder as the index.adoc
. Commit both the image and `index.adoc` to your fork of the repository and link:https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request[submit a pull-request] to the original KiCad repository

*Don't be afraid to try your best and ask for help in the link:https://github.com/KiCad/kicad-website[repository]!*
*Don't be afraid to try your best and ask for help in the link:https://gitlab.com/kicad/services/kicad-website[repository]!*
2 changes: 1 addition & 1 deletion layouts/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ <h1>Oops, page not found</h1>
<p>

Maybe these links will help you? Otherwise please
<a href="https://github.com/KiCad/kicad-website/issues/new">tell us on Github</a>.
<a href="https://gitlab.com/kicad/services/kicad-website/issues/new">tell us on Github</a>.
</p>
<ul class="col-md-offset-1">
<li><p><a href="/">Home page</a> introduction,</p></li>
Expand Down
2 changes: 1 addition & 1 deletion layouts/section/download.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ <h3>Select your operating system or distribution</h3>
<h3>My operating system or distribution isn't listed!</h3>
<p>
KiCad is an open source project, download instructions above are provided by the community.
If you'd like to provide builds for your operating system or distribution, please submit a <a href="https://github.com/KiCad/kicad-website">pull request.</a>
If you'd like to provide builds for your operating system or distribution, please submit a <a href="https://gitlab.com/kicad/services/kicad-website">pull request.</a>
</p>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions layouts/section/made-with-kicad.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ <h1>Made With KiCad</h1>
<p>
These are some KiCad designed projects that have been made by users. If you want to
be featured along the other showcases on this page please submit a pull request
<a href="https://github.com/KiCad/kicad-website">on GitHub</a> if you meet
the <a href="https://github.com/KiCad/kicad-website/blob/master/CONTRIBUTING.adoc">contributing guidelines</a>
<a href="https://gitlab.com/kicad/services/kicad-website">on GitHub</a> if you meet
the <a href="https://gitlab.com/kicad/services/kicad-website/blob/master/CONTRIBUTING.adoc">contributing guidelines</a>
for requirements on adding a project!
</p>
</div>
Expand Down