mirror of
https://gitlab.com/redline-racing-division/redline-racing-website.git
synced 2025-06-16 07:06:50 +00:00
updated the readme with info on managing sponsors.
This commit is contained in:
parent
13bc4424ab
commit
f4a48fed36
62
README.md
62
README.md
@ -1 +1,61 @@
|
||||
# This is where documentation of the website will likely live.
|
||||
# Website Documentation
|
||||
|
||||
The idea of this page is to make it so that even a monkey can make changes to the website. Unfortunately these docs were also written by a monkey so when you inevitably run into issues I suggest you consult [Google](https://google.com) or in dire cases you may want to contact the mysterious [Anson Biggs](mailto:anson@ansonbiggs.com).
|
||||
|
||||
- [Website Documentation](#website-documentation)
|
||||
- [Updating Sponsors](#updating-sponsors)
|
||||
- [Field Descriptions](#field-descriptions)
|
||||
- [Example list.json](#example-listjson)
|
||||
|
||||
## Updating Sponsors
|
||||
|
||||
Updating the sponsors is as simple as downloading a nice looking image of the sponsors logo, dropping it into the `./images/sponsors/` directory and editing the file in the `sponsors` directory named `list.json`. Inside the `list.json` file there is a list of companies with some metadata information that is used for building the webpage and telling search engines what the image actually is so its important that all fields are filled out as fully as possible and correctly.
|
||||
|
||||
### Field Descriptions
|
||||
|
||||
```json
|
||||
{
|
||||
"companyName": "Should be the full name of the company",
|
||||
"company_URL": "Should be the url pointing to the home page of the company unless otherwise specified. Preferably a https:// link.",
|
||||
"company_image": "images/sponsors/imgName.ext - This can also be a url to an image hosted on another site if the sponsor wants that, otherwise try to keep the file local and inside of the sponsors directory.",
|
||||
"SponsorLevel": "simply gold, silver, or bronze",
|
||||
"altText": "Full name of company and maybe their slogan or something. This describes what the image is to search engines and people that can't see well (more common than you would think). Try to keep this to 2-3 scentences don't write a novel like I am right now."
|
||||
}
|
||||
```
|
||||
|
||||
### Example list.json
|
||||
|
||||
```json
|
||||
{
|
||||
"Companies": [
|
||||
{
|
||||
"companyName": "Red Bull Racing",
|
||||
"company_URL": "https://redbullracing.redbull.com/",
|
||||
"company_image": "images/sponsors/RedBullEnergy.png",
|
||||
"SponsorLevel": "gold",
|
||||
"altText": "Red Bull Formula 1 Racing"
|
||||
},
|
||||
{
|
||||
"companyName": "Mercedes AMG",
|
||||
"company_URL": "https://www.mercedes-amg.com/en.html",
|
||||
"company_image": "images/sponsors/mercedes.png",
|
||||
"SponsorLevel": "bronze",
|
||||
"altText": "Mercedes Benz AMG"
|
||||
},
|
||||
{
|
||||
"companyName": "The Hub Grill and Bar",
|
||||
"company_URL": "https://www.hubgrill.com",
|
||||
"company_image": "images/sponsors/HUB_LOGO_OFFICIAL.png",
|
||||
"SponsorLevel": "silver",
|
||||
"altText": "The Hub Grill and Bar Mesa, Az"
|
||||
},
|
||||
{
|
||||
"companyName": "Haas F1",
|
||||
"company_URL": "http://haasf1team.com/",
|
||||
"company_image": "https://proxy.duckduckgo.com/iu/?u=https%3A%2F%2Fcdn.bleacherreport.net%2Fimages%2Fteam_logos%2F328x328%2Fhaas.png&f=1&nofb=1",
|
||||
"SponsorLevel": "gold",
|
||||
"altText": "Haas Formula One Team"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
31
README.txt
31
README.txt
@ -1,31 +0,0 @@
|
||||
Solid State by HTML5 UP
|
||||
html5up.net | @ajlkn
|
||||
Free for personal and commercial use under the CCA 3.0 license (html5up.net/license)
|
||||
|
||||
|
||||
After a somewhat extended break from HTML5 UP (to work on a secret-ish new project --
|
||||
more on that later!) I'm back with a brand new design: Solid State, a slick new multi-
|
||||
pager that combines some of the ideas I've played with over at Pixelarity with an "angular"
|
||||
sort of look. Hope you dig it :)
|
||||
|
||||
Demo images* courtesy of Unsplash, a radtastic collection of CC0 (public domain) images
|
||||
you can use for pretty much whatever.
|
||||
|
||||
(* = not included)
|
||||
|
||||
AJ
|
||||
aj@lkn.io | @ajlkn
|
||||
|
||||
|
||||
Credits:
|
||||
|
||||
Demo Images:
|
||||
Unsplash (unsplash.com)
|
||||
|
||||
Icons:
|
||||
Font Awesome (fontawesome.io)
|
||||
|
||||
Other:
|
||||
jQuery (jquery.com)
|
||||
Scrollex (github.com/ajlkn/jquery.scrollex)
|
||||
Responsive Tools (github.com/ajlkn/responsive-tools)
|
Loading…
x
Reference in New Issue
Block a user