Giter Club home page Giter Club logo

eclipsefdn / asciidoc-wg.eclipse.org Goto Github PK

View Code? Open in Web Editor NEW
3.0 11.0 10.0 1.29 MB

The AsciiDoc Working Group drives the standardization, adoption, and evolution of AsciiDoc. This group encourages and shapes the open, collaborative development of the AsciiDoc language and its processors.

Home Page: https://asciidoc-wg.eclipse.org/

License: Eclipse Public License 2.0

HTML 64.43% Less 21.44% JavaScript 6.40% Ruby 0.24% Dockerfile 6.52% Jsonnet 0.97%
webdev asciidoc hugo

asciidoc-wg.eclipse.org's Introduction

asciidoc-wg.eclipse.org


NOTE

This project was migrated to [Eclipse Gitlab](https://gitlab.eclipse.org/eclipse-wg/asciidoc-wg/asciidoc-wg.eclipse.org/) on September 21, 2021.


The https://asciidoc-wg.eclipse.org website is generated with Hugo.

The AsciiDoc Working Group drives the standardization, adoption, and evolution of AsciiDoc. This group encourages and shapes the open, collaborative development of the AsciiDoc language and its processors.

Getting started

Prerequisites

The following pre-requisites are necessary to create a local preview of the site. If you only want to change content without a local preview, only a text editor is necessary to change content.

Running a local preview of the site

Install dependencies, build assets and start a webserver:

npm install && hugo server --destination=public

You can find guidance on the page-level metadata here, and examples of the assorted page types (components) here.

Contributing

  1. Fork the eclipsefdn/asciidoc-wg.eclipse.org repository

  2. Clone repository: git clone your_github_username/asciidoc-wg.eclipse.org.git

  3. Create your feature branch: git checkout -b my-new-feature

  4. Commit your changes: git commit -m 'Add some feature' -s

  5. Push feature branch: git push origin my-new-feature

  6. Submit a pull request

Declared Project Licenses

This program and the accompanying materials are made available under the terms of the Eclipse Public License v. 2.0 which is available at https://www.eclipse.org/legal/epl-2.0.

SPDX-License-Identifier: EPL-2.0

Images, less and JavaScript files for the Eclipse Foundation look and feel.

Hugo theme of the Eclipse Foundation look and feel.

Bugs and feature requests

Have a bug or a feature request? Please search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Author

Christopher Guindon (Eclipse Foundation)

Trademarks

  • Eclipse® is a Trademark of the Eclipse Foundation, Inc.

  • Eclipse Foundation is a Trademark of the Eclipse Foundation, Inc.

  • AsciiDoc® is a Trademark of the Eclipse Foundation, Inc.

asciidoc-wg.eclipse.org's People

Contributors

abelsromero avatar ahus1 avatar amarantha-k avatar chrisguindon avatar dependabot[bot] avatar ggrossetie avatar gmarpons avatar lightguard avatar linkfang avatar lisaruff avatar mbarbero avatar mojavelinux avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

asciidoc-wg.eclipse.org's Issues

Create content for Membership and Benefits

Current preview: https://eclipsefdn-asciidoc-wg.netlify.app/membership/

The current content is implemented as two short-codes. The content of the short-codes is HTML.
Instead of two short codes (that are only used in this location) the content could be written as simple AsciiDoc.

Current page: https://github.com/EclipseFdn/asciidoc.eclipse.org/blob/main/content/membership/_index.adoc

Short codes: https://github.com/EclipseFdn/asciidoc.eclipse.org/tree/main/layouts/shortcodes/membership

Add link to issue tracker for the AsciiDoc WG

The AsciiDoc WG now has it's own issue tracker located at https://gitlab.eclipse.org/eclipse-wg/asciidoc-wg/asciidoc-wg/-/issues. Since this website is meant to be a portal for all orders of business of the AsciiDoc WG, I think it should be possible to navigate to this issue tracker from the website.

What I'm not sure yet is where this link would go. It would make sense for it to be shown next to the link for the mailing list. However, that link to the mailing list isn't currently in the navigation hierarchy. I suppose we could put it below the mailing list link on the home page, but that could look too busy.

Instead, I think we need a new item in the navigation somewhere named "Participate". This heading is consistent with Eclipse's own working group home page. Under this heading could be "Mailing list", "Issue tracker", and perhaps other communication channels in the future. I would even be open to putting the Participate heading under a "More" entry in the navbar if it's taking up too much space.

For examples, see https://www.eclipse.org/org/workinggroups/ and https://edgenative.eclipse.org/

Tags button build 404 url

Describe the bug
Project tags generate an URL (ie. http://{domain}/technology_types/java/) that does not exists.
For example the following project
image
Has Java tag which points to https://{domain}technology_types/java/.

To Reproduce
Steps to reproduce the behavior:

  1. Add new project with content
---
Title: Eclipse Austen
license: Eclipse Public License 2.0
is_incubated: true
website: https://projects.eclipse.org/proposals/eclipse-austen
github: https://myrepo.com
technology_types: [Java]
---
A description.
  1. Build preview accorfing to instructions in README (currently: npm install && hugo server --destination=public)
  2. Go to http://localhost:1313/projects/
  3. Click on the tag
  4. 404 screen

Expected behavior
At least not to fail.

Screenshots
n/a

Desktop (please complete the following information):

  • OS: Linux 5.11.14-1-MANJARO
  • Browser: Firefox
  • Version: 88.0 64bits

Smartphone (please complete the following information):
n/a

Additional context
https://asciidoc-wg.eclipse.org/technology_types/java/ also returns a 404.

Add link to repository from website

If I'm a reader or reviewer of the website, and I see a problem, I need to know how to suggest or propose a fix. Therefore, there should be a link from the website to this repository.

One approach is to add an "Edit this Page" link to every page. That would make it easy to find the link from every page. The downside is that it makes the website look more collaborative than it is. It's meant to be more for relying information than collaborating on it.

So an alternative is to add a link on the home page that reads "Have you found an error on this site? Report it or propose a fix here".

A third approach is to add a link somewhere in the navbar. Perhaps About > Report website issue.

I'm leaning more towards option (b).

Updating banner image

We noticed that the site is using the same banner image as eclipse.org, which may be confusing for some people. To help give AsciiDoc it's own look we have mocked up a couple of options for updated banner images. Let us know which (if either) you prefer and we can add the image files to the bug once you've provided your feedback.

Option A:
AsciiDoc Banner A - People

Option B:
AsciiDoc Banner B - Abstract

Replace the "Eclipse Foundation Events" section by a "Purpose" section

I think we should replace (or at least move it lower on the page) the "Eclipse Foundation Events" as it can be a bit misleading.

Here's the current content:

current

As you can see "Eclipse Foundation Events" section takes a lot of space and even draw the attention away from the hero section.

I think we should instead use this section to describe the purpose/mission of the Working Group.
Here's an example:
purpose

https://science.eclipse.org/

Rename repository to asciidoc-wg.eclipse.org

The AsciiDoc Working Group will have two web sites:

  • one to promote the language (asciidoc.org)
  • one to introduce the working group and its members

To make a better distinction of the two, the website of the working group steering committee decided that the working group website should be named asciidoc-wg.eclipse.org

@eclipsewebmaster - could you please

  • rename this repository from asciidoc.eclipse.org to asciidoc-wg.eclipse.org
  • rename the preview from https://eclipsefdn-asciidoc.netlify.app/ to https://eclipsefdn-asciidoc-wg.netlify.app/ (and change

Thanks!

Can't build successfully following the process in README file

Describe the bug

I created PR71 to update the Registered Symbol to AsciiDoc and would like to preview my changes, but couldn't make it work.

With all 3 dependencies installed mentioned in README file - Node and NPM (14.7.1), Hugo, and Asciidoctor, when I run "hugo server --destination=public" command, I will get this error:
image

After I change

_build:
  render: never

to

_build:
  render: false

The error above would gone, but then I will get this error:
image

I am using Windows 10 - WSL2 - Ubuntu.
Not sure if I missed something or did something wrong?

Update this repo's README

The updated README should be updated to contain:

  • the scope of the web site it supports (asciidoc-wg.eclipse.org vs. asciidoc.org)
  • Ammend authors of the repo (as possible contacts for people to ask questions) - adding different roles to different people; for example Guillaume and Alex maintaining content, Chris creating the original template and infrastructure setup
  • Adding AsciiDoc as a trademark to the list

Publishing the site to asciidoc-wg.eclipse.org

This will be done once all content is ready for the first publishing of this site.

All content that should be part of this is marked as Milestone "M1"

Pre-requisite: #3 (rename from asciidoc to asciidoc-wg)

Create AsciiDoc WG Website

I made the initial commit for this project. I did my best to include variations of the different things you can do with our template.

For example, I added a menu, sidebar menu, and dropdown menus in https://github.com/EclipseFdn/asciidoc.eclipse.org/blob/main/config.toml

The content of the main branch is available via https://eclipsefdn-asciidoc.netlify.app/. However, the plan would be to host the site on EF infra under asciidoc.eclipse.org.

GETTING STARTED:
https://github.com/EclipseFdn/asciidoc.eclipse.org#getting-started

Hugo Documentation:
https://gohugo.io/documentation

Theme Documentation:
https://eclipsefdn-hugo-solstice-theme.netlify.app/

Eclipse Foundation Hosted Services Privacy and Acceptable Usage Policy:
https://blogs.eclipse.org/post/christopher-guindon/eclipse-foundation-hosted-services-privacy-and-acceptable-usage-policy

@rkratky @ahus1 Please let us know if you have any questions via this issue!

Explore "featured content" on AsciiDoc start page

In issue #29 and PR #34 / 3c37500 we've replace the "featured content" (at that time mentioning the "Eclipse Foundation Events") with content hosted in the AsciiDoc WG Git repo describing the "purpose" of the AsciiDoc working group.

As pointed out by @chrisguindon, the Eclipse Marketing team maintains and updates the content delivered for the "featured content" widget on the site.
@shanda-eclipse let us know that we can send content to her via email: [email protected]

This is a follow-up issue to find out:

  • what are the trade-offs of using the "featured story" mechanism delivering dynamic content vs. static content on the working group's start page?
  • who is responsible/the driver for the content of the "featured story" - the working group or the Eclipse Marketing team?
  • what are recommendations/best practices of the Eclipse Marketing team to have on a working group's start page?

Possible outcomes of this issue:

  • stay with having the content in the git repository OR using the featured story mechanism with content maintained by the Eclipse Marketing team
  • stay with the "purpose" content OR come up with different content that fits better to the start page

Add overview of Steering Committee

The site will have an overview of all Partner members and Committer members (#4).

To add names and faces to the steering group, there should be content on each appointed partner member seat and each elected community seat.

This continues the work started in #4.

Add optionl "Code repo" button to projects

Is your feature request related to a problem? Please describe.
Projects right now display a "Website" button in the summary in single views.
I'd be nice to also link the code repo url when this is setup.

Describe the solution you'd like
Same format and style as "Website" button is good for now.
As nite-2-have, maby explore adding a git tree icon to make it git-provider agnostic.

Describe alternatives you've considered
n/a

Additional context
Related conversation: #64 (comment)

Adding dependabot

This will allow dependencies to be updated semi-automatically by an automatically created pull request by dependabot.

Add Eclipse Austen as a project to the WG site

The project Eclipse Austen currently being setup/created. https://projects.eclipse.org/proposals/eclipse-austen

Once it is ready, it should be on the WG's project list: https://asciidoc-wg.eclipse.org/projects/

@abelsromero - could you please take on this task once Eclipse Austen should appear on the WG's site?

Content goes here: https://github.com/EclipseFdn/asciidoc-wg.eclipse.org/tree/main/content/projects
The Hugo setup would require a new folder austen as a sibling to the folder asciidoc-lang with similar content.

Thanks!

Add @Mogztter as committer to this repo

As @Mogztter has shown commitment to improve this site in several ways I asked him to join this repo as a committer. I'm happy to write that he agreed!

@eclipsewebmaster - could you please add permissions for @Mogztter to this repo? He should basically have the same permissions as Robert and me.
Thanks!

(Quote of the day: "To infinity and beyond!" / Buzz Lightyear)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.