Skip to content

Commit

Permalink
Adding new pages for documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
computate committed Nov 4, 2022
1 parent 6b893e7 commit c8e86a0
Show file tree
Hide file tree
Showing 2 changed files with 494 additions and 0 deletions.
247 changes: 247 additions & 0 deletions page/openssf-best-practices.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,247 @@
---
pageId: "open-source-software-foundation-best-practices-{{ page.siteName }}"
uri: "/en-us/{{ pageId }}"
h1: "Does the {{ page.siteName }} project follow the OpenSSF Best Practices? "
h2: "Review the OpenSSF Best Practices checklist for {{ page.siteName }}. "
created: "2022-07-05"
author:
name: Christopher Tate
title: Red Hat Principal Software Consultant
pageImageUri: "/png/{{ pageId }}/infographic.png"
htmTitle:
- text: "{{ h1 }}{{ h2 }}"
htmMeta:
- {e: meta, a: {property: "og:title", content: "{{ h1 }}"}}
- {e: meta, a: {property: "og:description", content: "{{ h2 }}"}}
- {e: meta, a: {property: "og:url", content: "{{ page.siteBaseUrl }}{{ uri }}"}}
- {e: meta, a: {property: "og:site_name", content: "{{ page.siteName }}"}}
- {e: meta, a: {property: "og:image", content: "{{ page.staticBaseUrl }}{{ pageImageUri }}"}}
- comment: |
CutyCapt --min-height=1 --url='{{ page.siteBaseUrl }}{{ uri }}?var=filterLabel:infographic' --out='{{ page.staticPath }}/png/{{ pageId }}/infographic.png'
CutyCapt --min-height=1 --url='{{ page.siteBaseUrl }}{{ uri }}?var=filterLabel:image' --out='{{ page.staticPath }}/png/{{ pageId }}/image.png'
CutyCapt --min-height=1 --url='{{ page.siteBaseUrl }}{{ uri }}?var=filterLabel:review' --out='{{ page.staticPath }}/png/{{ pageId }}/review.png'
- {e: meta, a: {property: "og:image:width", content: "{{ page.pageImageWidth }}"}}
- {e: meta, a: {property: "og:image:height", content: "{{ page.pageImageHeight }}"}}
- {e: meta, a: {property: "og:image:type", content: "{{ page.pageImageType }}"}}
- {e: meta, a: {property: "og:image:alt", content: "{{ h1 }} {{ h2 }}"}}
- {e: meta, a: {property: "og:type", content: "article"}}
- {e: meta, a: {property: "twitter:card", content: "summary_large_image"}}
- {e: meta, a: {property: "twitter:title", content: "{{ h1 }}"}}
- {e: meta, a: {property: "twitter:description", content: "{{ h2 }}"}}
- {e: meta, a: {property: "twitter:image", content: "{{ page.staticBaseUrl }}{{ pageImageUri }}"}}
- {e: meta, a: {property: "description", content: "{{ h2 }}"}}
htmBody:
- e: div
a:
class: w3-card w3-padding w3-margin-top w3-show w3-white
in:
- e: div
in:
- e: h1
a:
class: ""
in:
- e: i
a:
class: fa-solid fa-question padding-right-quarter-em
- e: span
text: "{{ h1 }}"
- e: h2
a:
class: ""
in:
- e: i
a:
class: fa-solid fa-sort padding-right-quarter-em
- e: span
text: "{{ h2 }}"
- e: div
a:
class: w3-row w3-mobile
label:
- infographic
- image
in:
- e: div
a:
class: w3-row w3-mobile
label:
- infographic
- image
in:
- e: img
a:
class: w3-image
src: "{{ page.staticBaseUrl }}/png/{{ pageId }}/image.png"
- e: div
in:
- e: div
a:
class: w3-padding
in:
- e: h3
a:
class: ""
in:
- e: i
a:
class: fa-regular fa-magnifying-glass-arrow-right padding-right-quarter-em
- e: span
text: Basics
- e: h4
a:
class: ""
in:
- e: i
a:
class: fa-sharp fa-solid fa-coffee-bean padding-right-quarter-em
- e: span
text: In progress
- e: h4
text: |
Basic project website content
- e: ul
in:
- e: li
in:
- e: span
class: font-weight-bold
text: "The project website MUST succinctly describe what the software does (what problem does it solve?): "
- e: span
text: |
The main query parameter for full-text search.
- e: li
in:
- e: span
class: font-weight-bold
text: "The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software: "
- e: span
text: |
The fq parameter defines a query that can be used to restrict the superset of documents that can be returned, without influencing score.
It can be very useful for speeding up complex queries, since the queries specified with fq are cached independently of the main query.
When a later query uses the same filter, there’s a cache hit, and filter results are returned quickly from the cache.
- e: li
in:
- e: span
class: font-weight-bold
text: "The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?): "
- e: span
text: |
The fl parameter limits the information included in a query response to a specified list of fields. The fields must be either stored="true" or docValues="true".
The field list can be specified as a space-separated or comma-separated list of field names.
The string "score" can be used to indicate that the score of each document for the particular query should be returned as a field.
The wildcard character * selects all the fields in the document which are either stored="true" or docValues="true" and useDocValuesAsStored="true" (which is the default when docValues are enabled).
You can also add pseudo-fields, functions and transformers to the field list request.
- e: li
in:
- e: span
class: font-weight-bold
text: "The information on how to contribute SHOULD include the requirements for acceptable contributions (e.g., a reference to any required coding standard): "
- e: span
text: |
The sort parameter arranges search results in either ascending (asc) or descending (desc) order.
The parameter can be used with either numerical or alphabetical content.
The directions can be entered in either all lowercase or all uppercase letters (i.e., both asc and ASC are accepted).
- e: div
label:
- infographic
- review
a:
id: divReview
in:
- e: table
a:
id: tableReview1
class: review1Table
in:
- e: tbody
in:
- e: tr
a:
class:
in:
- e: td
a:
class: w3-mobile review1TableTr1Td1 review1TableTr1Td even
in:
- e: span
text: '{{formatZonedDateTime created "EEEE" "en-US" "America/Denver" }}'
- e: td
a:
class: w3-mobile review1TableTr1Td2 review1TableTr1Td odd
in:
- e: i
a:
class: "{{ htmBody.0.in.0.in.0.in.0.a.class }}"
- e: td
a:
class: w3-mobile review1TableTr1Td3 review1TableTr1Td even
in:
- e: i
a:
class: "{{ htmBody.0.in.0.in.1.in.0.a.class }}"
- e: td
a:
class: w3-mobile review1TableTr1Td4 review1TableTr1Td odd
in:
- e: i
a:
class: "fa-solid fa-pen-nib"
- e: tr
a:
class: odd
in:
- e: td
a:
class: w3-mobile review1TableTr2Td1 review1TableTr2Td even
in:
- e: span
text: '{{formatZonedDateTime created "MMMM d yyyy" "en-US" "America/Denver" }}'
- e: td
a:
class: w3-mobile review1TableTr2Td2 review1TableTr2Td odd
in:
- e: span
text: "{{ h1 }}"
- e: td
a:
class: w3-mobile review1TableTr2Td3 review1TableTr2Td even
in:
- e: span
text: "{{ h2 }}"
- e: td
a:
class: w3-mobile review1TableTr2Td4 review1TableTr2Td odd
in:
- e: span
text: "{{ author.name }}"
- e: table
a:
id: tableReview2
class: review2Table
in:
- e: tbody
each: htmBody.0.in.1.in
in:
- e: tr
a:
class: "{{#even @index }}review2TableTr even {{else}}review2TableTr odd {{/even}}"
in:
- e: td
a:
class: w3-mobile
in:
- e: i
a:
class: "{{ item.in.0.in.0.a.class }}"
- e: span
text: '{{ item.in.0.in.1.text }}'
- e: td
a:
class: w3-mobile
in:
- e: i
a:
class: "{{ item.in.1.in.0.a.class }}"
- e: span
text: '{{ item.in.1.in.1.text }}'
Loading

0 comments on commit c8e86a0

Please sign in to comment.