nushell / nushell/nushell.github.io

a refactoring idea to rewrite the `README`

Abierto
#814 2 comentarios 3 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
TypeScript
Estrellas
258
Forks
561
Merge medio
3 h 20 min
PR fusionados (30 d)
15

Descripción

hello there 👋 😋

i feel this website repository is mainly made for developers or people who click on the "Edit this page on GitHub" button in the footer.

the other day i was looking for contribution guidelines and ended up asking how to run the website locally on the discord...
i did not see the CONTRIBUTING.md file in the root of the repo 😭

in fact, i looked at the main README, looking for instructions but found none => this is because the main ./README.md file IS the
english frontpage of www.nushell.sh!

my idea

i propose to move the frontpage of the website to some other place than ./README.md and write a true development-oriented README.md
to:

  • point to the website itself at www.nushell.sh
  • point to the main nushell repo
  • explain in details how to contribute to this repo OR at least explicitely point to CONTRIBUTING.md

some details

  • i think the paths to all the pages MD files are specified in .vuepress/configs/, right?
  • i propose to move blog/, book/, commands/, contributor-book/ and cookbook/ to a new en/ directory, leading to the following architecture:
.
├── CNAME
├── CONTRIBUTING.md
├── i18n-meta.json
├── i18n.nu
├── LICENSE
├── make_docs.nu
├── package.json
├── package-lock.json
├── README.md
├── assets/
├── de/
├── es/
├── en/
├── ja/
├── pt-BR/
├── snippets/
├── tr/
└── zh-CN/

and one more level details

.
├── CNAME
├── CONTRIBUTING.md
├── i18n-meta.json
├── i18n.nu
├── LICENSE
├── make_docs.nu
├── package.json
├── package-lock.json
├── README.md
├── assets
│   └── images
├── de
│   ├── README.md
│   └── book
├── es
│   ├── README.md
│   ├── book
│   └── contributor-book
├── en
│   ├── blog
│   ├── book
│   ├── commands
│   ├── contributor-book
│   └── cookbook
├── ja
│   ├── README.md
│   └── book
├── pt-BR
│   ├── README.md
│   ├── book
│   └── contributor-book
├── snippets
│   ├── installation
│   ├── introduction
│   └── moving_around
├── tr
│   ├── README.md
│   └── book
└── zh-CN
    ├── README.md
    └── book

that way

  • the english default channel would be just another language channel, even though the prefered one by default
  • the repo would have a more homogenous structure
  • we would be able to move the english frontpage from README.md to en/README.md, as with the other languages
  • we would be able to write a true README for the website repo

i wanted to have some feedback before trying to refactor the website like this.
shouldn't be that much work, mainly changing paths, but ehe 😉

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con README.md, CONTRIBUTING.md y las definiciones de rutas en .vuepress/configs/. Revisa cómo se referencian blog/, book/, commands/, contributor-book/, cookbook/ y los directorios de idiomas antes de proponer el traslado. Se considera completado cuando el repositorio tiene un README orientado al desarrollo, el contenido en inglés está bajo en/ y todas las rutas documentadas siguen siendo coherentes.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
markdown
Área
documentation, internationalization
Tipo de issue
Refactorización
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
32/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.