gruntwork io.github.io

Sitio web de Gruntwork.io

Este es el código para el sitio web de Gruntwork.

Gruntwork puede ayudarlo a obtener toda su infraestructura, definida como código, en aproximadamente un día. Te enfocas en tu producto. Nos encargaremos de los gruñidos.

Docker Start Rapid

La forma más rápida de lanzar este sitio es usar Docker.

1. git clone este repositorio
2. docker compose up
3. Vaya a http://localhost:4000 para probar
4. Si va a probar el flujo de pago, debe iniciar sesión en apertura en: https://aperture.dogfood-stage.com/.

La configuración predeterminada de Docker Compose admite la recuperación de calor de su entorno local, lo que significa que a medida que edita archivos para cambiar el marcado, el texto, las imágenes, etc., su servidor de desarrollo local recogerá estos cambios y recargará la última versión del sitio para usted. Esto hace que sea rápido y conveniente desarrollar en el sitio localmente.

Comienzo rápido manual

1. git clone este repositorio
2. Instalar jekyll
3. Solo la primera vez: bundle install
4. Iniciar servidor Jekyll: bundle exec jekyll serve --livereload
5. Vaya a http://localhost:4000
6. Si va a probar el flujo de pago, debe iniciar sesión en apertura en: https://aperture.dogfood-stage.com/.

Despliegue

Para implementar el sitio:

1. Cree un PR con sus cambios en el código
2. Después de que el PR haya sido aprobado, fusionándolo en master
3. Cree una nueva etiqueta, puede hacerlo manualmente a través de GIT o en el paso posterior en la página de comunicados; asegúrese de incrementar el número de versión utilizando versiones semánticas
4. Vaya a la página de versiones y cree una versión en borrador con la información relevante (use el botón "Generar Notas de versión" para facilitar su vida)
5. Lanzarlo
6. La tubería CI/CD lo implementará automáticamente

Tecnologías

1. Construido con Jekyll. Este sitio web es completamente estático y utilizamos HTML o Markdown básico para todo.
2. Los entornos de vista previa están construidas con Netlify.
3. Alojado en Amazon S3, con CloudFront como un CDN. Uso de S3_WebSite para cargar automáticamente contenido estático a S3.
4. Usamos bootstrap y menos.
5. Estamos utilizando UptimeBot, Google Analytics y Hubspot Traffic Analytics para monitoreo y métricas.

Solución de problemas

Deshabilitar la gema de alimentación de Jekyll

El sitio web de Gruntwork utiliza una gema Ruby llamada Jekyll Feed que genera una alimentación RSS estructurada de "publicaciones" en el sitio. Desafortunadamente, en el desarrollo, esto puede ralentizar significativamente la recuperación de calor del sitio, lo que lo obliga a esperar más de un minuto a la vez para ver cambios de texto menores localmente.

Sabrá que esto está sucediendo cuando mira el STDOUT de su proceso docker-compose y el recuento final de segundos gastados Generating feed for posts es mayor que 5:

 web_1  |       Regenerating: 1 file(s) changed at 2021-07-21 14:31:08
web_1  |                     _data/website-terms.yml
web_1  |        Jekyll Feed: Generating feed for posts
web_1  |                     ...done in 58.507850014 seconds.

Como una solución temporal, puede abrir el archivo Gem en la raíz del directorio del proyecto y comentar temporalmente la línea que atrae la dependencia de Jekyll Feed:

 source 'https://rubygems.org'
gem 'jekyll', '~> 4.1'
gem 's3_website', '3.3.0'
group :jekyll_plugins do
  gem 'jekyll-redirect-from', '0.16.0'
  gem 'jekyll-sitemap', '1.4.0'
  gem 'jekyll-paginate', '1.1.0'
  gem 'therubyracer', '0.12.3'
  gem 'less', '2.6.0'
  gem 'jekyll-asciidoc'
  gem 'jekyll-toc'
  gem 'nokogiri', '1.11.0.rc4' # Addressing security issue in earlier versions of this library
#  gem 'jekyll-feed'
end

Importante : ¡asegúrese de no terminar cometiendo este cambio porque queremos que el complemento de alimentación Jekyll se ejecute para la producción!

Hice cambios localmente, pero no se están reflejando en mi entorno de desarrollo relacionado con el calor.

Esto puede suceder especialmente si agrega o elimina archivos del directorio de trabajo del sitio web. Cuando esto ocurra, termine su proceso docker-compose y reinicie para ver sus cambios reflejados.

Licencia

Ver licencia.txt.