seagl.github.io

SeaGL

Este é o código-fonte de um site servido em https://seagl.org.

Ele usa Jekyll como gerador de site estático com GitHub Pages.

O site é renderizado automaticamente sempre que o código é enviado para o repositório compartilhado no GitHub.

Basicamente, os passos para atualizar o site (para publicar um novo post no blog, por exemplo), são:

1. Bifurque/clone o repositório,
2. Faça suas alterações,
3. Teste suas alterações,
4. Envie uma solicitação pull (PR) para as alterações,
5. Assim que o PR for mesclado, suas alterações serão publicadas ao vivo

Há instruções para cada uma dessas etapas abaixo. As instruções presumem que alguém com menos experiência técnica em git/GitHub/está executando o trabalho. Aqueles com mais experiência podem extrapolar de acordo. :-)

Bifurcar/clonar o repositório

Embora você provavelmente possa trabalhar diretamente neste repositório, as práticas recomendadas são que não. Em vez disso, você pode bifurcar ou clonar o repositório e fazer alterações nessa cópia. Isso permite testes antes de colocar as alterações em operação e reduz o risco de uma alteração mal formatada ou redigida escapar para o mundo.

Para bifurcar o repositório:

1. Clique no garfo na parte superior da página.
2. Selecione a conta/organização de destino para a cópia do repositório.
3. Espere que tudo seja copiado.

Voilá! Isso é tudo que há para fazer.

Faça suas alterações

Se você estiver adicionando uma nova postagem no blog, siga estas regras de nome de arquivo:

• Coloque todas as postagens do blog no diretório _posts .
• Inicie o nome do arquivo com uma data no formato YYYY-MM-DD . Isso é muito importante porque controla a ordem em que o site exibe as postagens do blog.
  • NOTA BENE : O site exibirá postagens datadas até a data atual, inclusive. Isso permite que você agende postagens com antecedência, mas também significa que postagens com datas futuras não aparecerão, a menos que você use --future ao testar suas alterações. No momento, também é necessário que você acione uma reconstrução do site na data agendada ou após ela para que a postagem apareça. Isso pode ser feito com: git commit -m 'rebuild pages' --allow-empty && git push origin main ou fazendo qualquer alteração real no site.
• Após a data, coloque um travessão ( - ) e, em seguida, um título delimitado por travessão para a postagem. Este título não é exibido. É apenas para nomear o arquivo. Por favor, seja breve, mas descritivo.
• Use a extensão de nome de arquivo .md para indicar que a postagem é composta no formato Markdown. (e escreva postagens apenas usando Markdown)

Por estas regras, um post de blog anunciando a abertura do PCP 2017 poderia ter um nome de arquivo:

 2017-06-19-CFP-open.md

Adicione também o seguinte no topo do seu arquivo:

 ---
layout: post
title: 'Example Title'
status: publish
type: post
published: true
categories: news
tags: '2013'
---

Defina title como o título da postagem do seu blog e edite tags para incluir o ano da conferência ao qual a postagem está associada (vazio se não houver). Por favor, deixe o restante dos valores como estão.

Para o conteúdo real do arquivo, você pode fazer alterações na interface da web do GitHub ou em sua máquina local.

No GitHub

1. Navegue até o diretório onde está o arquivo que você deseja editar ou adicionar (provavelmente _posts ).
2. Para criar um novo arquivo:
   • Clique em Create a new file
   • Nomeie seu arquivo (de acordo com as instruções acima, se for uma postagem de blog)
3. Faça suas alterações
   • Para criar um novo arquivo:
     • Clique em Create a new file
     • Digite um nome de arquivo (de acordo com as instruções acima, se for uma postagem de blog)
   • Para editar um arquivo existente:
     • Clique no arquivo para selecioná-lo
     • Clique no pequeno ícone de lápis
   • De qualquer forma, agora você pode editar o arquivo na interface web.
4. Confirme suas alterações usando o formulário Commit changes abaixo da interface de edição.
   • Insira um título breve, mas descritivo, como "Adicionando anúncio de abertura do CFP 2017".
   • Insira uma descrição detalhada. Se você estiver trabalhando em um problema, consulte o número do problema aqui. Use uma marca de hash ( # ) seguida de um número de problema ( #74 ). Isso será vinculado automaticamente na solicitação pull, o que é muito útil.

Na sua máquina local

TBD (supõe-se que aqueles que usam git em suas máquinas locais já sabem disso; preencheremos mais tarde)

1. clonar seu garfo
2. faça suas alterações (adicione e/ou edite arquivos)
3. confirme suas alterações de volta ao seu fork

Teste suas alterações

Teste todas as alterações localmente antes de enviar para o GitHub.

Servidor de desenvolvimento local

Iniciar um servidor de desenvolvimento local disponibilizará sua cópia do site em http://localhost:4000. Existem algumas maneiras de executar o servidor. Faça a sua escolha!

Opção 1: metal puro

Dependências:

• Rubi
• Empacotador

Configuração única:

bundle install

Inicie o servidor:

bundle exec jekyll serve --watch

Para visualizar postagens com datas futuras e não publicadas, adicione --future --unpublished ao comando acima.

Opção 2: Containerizado

Dependências:

• Docker (ou Podman; substitua docker por podman )

Configuração única:

docker build --tag ' seagldev ' ' . '

Inicie o servidor:

docker run --rm --interactive --tty --publish ' 4000:4000 ' --volume " $PWD :/usr/src/app " ' seagldev '

Para visualizar postagens com datas futuras e não publicadas, adicione --future --unpublished no final do comando acima.

Envie uma solicitação pull (PR) para as alterações

Você pode enviar um PR na interface do GitHub ou de sua máquina local.

No GitHub

1. No seu navegador, navegue até o fork do repositório seagl.github.io.
2. Clique na guia Pull requests .
3. Clique no New pull request button .
4. O GitHub reconhece que seu repositório é um fork e o padrão é que o PR seja o branch principal de sua solicitação contra o branch principal de seagl.github.io. As probabilidades são muito boas, é isso que você quer. Se não for, você saberá o suficiente para perceber isso. :-)
5. Clique em Create pull request .
6. Insira um título breve, mas descritivo, como "Adicionando anúncio de abertura do CFP 2017".
7. Insira uma descrição detalhada. Se você estiver trabalhando em um problema, consulte o número do problema aqui. Use uma marca de hash ( # ) seguida de um número de problema ( #74 ). Isso será vinculado automaticamente na solicitação pull, o que é muito útil.
8. Selecione [Allow edits from maintainers](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) para que outros membros da equipe possam fazer edições, se necessário.
9. Clique em Create pull request .

Na sua máquina local

TBD (supõe-se que aqueles que usam git em suas máquinas locais já sabem disso; preencheremos mais tarde)

Suas alterações serão publicadas ao vivo

Agora alguém (talvez você, se tiver esse nível de acesso ao repositório) deve revisar e mesclar sua solicitação pull.

Assim que sua solicitação pull for mesclada, ela será publicada no site.

NOTA BENE : A mesclagem em si não acionará a reconstrução do site. Para reconstruir o site, você precisa enviar um commit vazio assim:

git commit --allow-empty -m " Rebuild the site, please " && git push

Como adicionar imagens às postagens

Adicione sua imagem ao diretório img/posts/ e use o seguinte Markdown:

 ![ Example description ] ( /img/posts/example.jpg )

Pontas:

• Para alinhar a imagem ao lado, adicione a classe align-left ou align-right :

   ![ Example description ] ( /img/posts/example.jpg ) {:.align-left}

• Para manter o tempo de carregamento da página, redimensione as imagens para um tamanho razoável antes de usá-las em uma postagem.

Arquivo de conferências anteriores

As conferências anteriores são arquivadas estaticamente como coleções Jekyll:

• archive-conferences
• archive-sessions

Para criar o arquivo de um determinado ano, primeiro importe os dados do cronograma—

bundle exec rake import[2020]

— em seguida, edite os arquivos compactados manualmente se alguma correção for necessária.