Light

webplatform / docs Goto Github PK

View Code? Open in Web Editor NEW

30.0 8.0 25.0 35.51 MB

WebPlatform Docs content migrated into a Git repository

Home Page: http://67.205.62.59/

License: Other

docs's Introduction

WebPlatform Docs

This repository should be the replication of WebPlatform.org content and user contribution as of 2015-09-04

Goals

Allow us to save on computing resources by serving static files
Use tools web developer already uses, ease contribution

To read more about the conversion process we've been through, you can refer How was it done section below.

Purpose, how to setup and use

This repository contains raw documentation files in Markdown format that is used on WebPlatform Docs.

Content is separated in multiple repositories, this one has main docs pages.

Planning, and discussions ("other content") are migrated into separate repositories:

To get the docs pages, refer to the following git repositories.

Submodule	Note
(this repo)	The main docs pages
webplatform/docs-meta	Archived content that needed to be moved during mass imports. We kept them there to cherry-pick and merge into the main content section. Was accessible under the URL docs.webplatform.org/wiki/Meta:...
webplatform/docs-wpd	Community and notes section. Was accessible under the URL docs.webplatform.org/wiki/WPD:...

To publish the site, we use a static site generator, see webplatform/generator-docs repository

Expected steps

See webplatform/generator-docs

How was it done?

To learn how the conversion was done, take a look at the mediawiki-conversion utility and the webplatform/content-converter library.

docs's People

Stargazers

Watchers

docs's Issues

Review pages that had issue during import

The following pages returned errors during attempt to convert from MediaWiki to HTML.

Pages to review

Potential potential false positives

Prior to shut down MediaWiki, ensure all "... Further results" are fully imported in static site

Let’s make HTML some MediaWiki ASK query results.

In order to stop relying on MediaWiki, we got to make sure all contents that were linked automatically through Semantic MediaWiki is kept as static HTML.

In some views, you might see a link that links to "... further results" like below;

The issue is that since we won’t have MediaWiki anymore, those links will be broken.

See also: webplatform/mediawiki-conversion#9.

How to do

We hae no choice to do this manually on any page that has SemanticMediaWiki or subpages wiki macros because we’re getting out of MediaWiki and we will lose the work made to make those dynamic lists.

To keep the list content for posterity, we gotta find pages that makes reference to them (e.g. grep -rli 'subpages' content/WPD/) and attempt to rework the wiki document to make the HTML give us the full listing output.

Otherwise we’ll lose that data

HTML file has a table with classname "wikitable smwtable", or just search entries that has "further results" mentioned.
```
grep -rli 'further results' content
```
Get Full view (if possible) by using MediaWiki ASK query helper
Once we see no "more..." link at the bottom of the view. Click on "show embed code" so that you can copy query code.

{{#ask:[[Path::~*apis/*]] [[Content quality flag::~Examples Needed]]
|?Path
|?Summary
|?Modification date
|format=broadtable
|limit=500
|offset=15
|sort=Modification date
|order=desc
|headers=plain
|mainlabel=-
|searchlabel='''More results'''
|default={{{default_text}}}
}}

Converted:

Pages to review

Recommend Projects

React

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

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

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

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
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.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

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

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.