Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NexT v7 Docs #36

Closed
10 of 16 tasks
ivan-nginx opened this issue Sep 13, 2018 · 22 comments
Closed
10 of 16 tasks

NexT v7 Docs #36

ivan-nginx opened this issue Sep 13, 2018 · 22 comments

Comments

@ivan-nginx
Copy link
Member

ivan-nginx commented Sep 13, 2018

@sli1989
Copy link
Contributor

sli1989 commented Sep 13, 2018

I think .travis.yml is needed to be re-edited and check on my version. there are some problem maybe.

@stevenjoezhang
Copy link
Contributor

What about moving /docs to wiki pages? Many links are broken in these .md files, for example, in https://github.com/theme-next/hexo-theme-next/blob/master/docs/zh-CN/CODE_OF_CONDUCT.md, when you click the national flag for another language, it will return a 404 NOT FOUND error.
Create wiki pages will make it easier to maintain.

@ivan-nginx
Copy link
Member Author

All main docs will be in website.
About other github docs – this links can be fixed.
Wiki a little bit hard for maintenance.

@jiangtj
Copy link
Member

jiangtj commented Nov 10, 2018

How about use other static site generators to generate website, such as docsify VuePress etc?
wow, NexT has submenu. It's wonderful for docs. Sorry for what I said before.

@ivan-nginx
Copy link
Member Author

I think better will be on Hexo & NexT, and it's already done (later will be with multilanguage, like Hexo site). The problem is – too many docs & configurations. We working with Alex on it and site will be ASAP. You also can join to working on site, just write me in Telegram, if you want.

@ivan-nginx ivan-nginx pinned this issue Dec 13, 2018
@ivan-nginx ivan-nginx unpinned this issue Dec 13, 2018
@ivan-nginx ivan-nginx pinned this issue Dec 13, 2018
@stevenjoezhang
Copy link
Contributor

Recommendation: Publish a new article on theme-next.org each time a new version of NexT is released (Could be done by a bot)

@ivan-nginx
Copy link
Member Author

Nice idea. Which bot can do it?

@stevenjoezhang
Copy link
Contributor

stevenjoezhang commented Mar 5, 2019

@ivan-nginx I have wrote one:

const request = require("request"),
    fs = require("fs");

function get() {
    request.get({
        url: "https://api.github.com/repos/theme-next/hexo-theme-next/releases",
        headers: {
            "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/11.1.2 Safari/605.1.15"
        }
    }, function(error, response, body) {
        fs.writeFileSync("data.json", body);
    });
}

function parse() {
    data = JSON.parse(fs.readFileSync("data.json"));
    for (i of data) {
        version = i.html_url.replace("https://github.com/theme-next/hexo-theme-next/releases/tag/v", "");
        time = i.published_at.replace("T", " ").replace("Z", " ");
        body = i.body.replace(/#(\d{1,})/g, "[#$1](https://github.com/theme-next/hexo-theme-next/pull/$1)").replace(/\r\n/g, "\n");
        var str = `---
title: NexT ${version} Released
date: ${time}
---

${body}

[Detailed changes for NexT v${version}](https://github.com/theme-next/hexo-theme-next/releases/tag/v${version})`;
        fs.writeFileSync(`next-${version.split(".").join("-")}-released.md`, str);

    }
}

parse();

Need to run manually

@ivan-nginx
Copy link
Member Author

Hmm... 🤔 Need to run from own server or how? Need something like reproduce steps. Mb it can be added under the cron.

@stevenjoezhang
Copy link
Contributor

stevenjoezhang commented Mar 6, 2019

Another suggestion: using bots to keep all these theme-next-* repos up to date.
https://github.com/backstrokeapp/server

@ivan-nginx
Copy link
Member Author

Yeah, dude! U look in the right way.

@stevenjoezhang
Copy link
Contributor

@ivan-nginx How about adding some warnings to README.md in v5.x to warn the users that the old project is no longer maintained?
2019-03-08 12 11 10

@ivan-nginx
Copy link
Member Author

@stevenjoezhang Yes, nice idea. You can add it, I'll merge.

@stevenjoezhang stevenjoezhang unpinned this issue Mar 14, 2019
@stevenjoezhang stevenjoezhang pinned this issue Mar 14, 2019
@stevenjoezhang stevenjoezhang transferred this issue from theme-next/hexo-theme-next Mar 23, 2019
@stevenjoezhang stevenjoezhang pinned this issue Mar 23, 2019
@stevenjoezhang

This comment has been minimized.

@ivan-nginx
Copy link
Member Author

ivan-nginx commented Mar 24, 2019

Besides, do you think there are too many documents about the licence?
https://github.com/theme-next/hexo-theme-next/blob/master/LICENSE.md
https://github.com/theme-next/hexo-theme-next/blob/master/docs/LICENSE.txt
https://github.com/theme-next/hexo-theme-next/blob/master/docs/AGPL3.md

Maybe we can merge them into a single LICENCE file, and then use an ISSUE to maintain a list of contributor (and credits), just like the v7.x ROADMAP

I'm right now working on it, not only on License. Don't touch this docs for now.


About

Yes, theme-next.org can be multi-language. Translated articles are more friendly to users.

Need to move this docs to the site, theme-next.org/docs/..

Actually, some docs already there.

So, my mistake with the question above: #36 (comment) – answer is no. Need just create link from this repos to site with docs with usage for this module.

@stevenjoezhang
Copy link
Contributor

For now it seems fine... there are only docs in English on theme-next.org.
We can deal with the multi-language issues in the future. Lots of work need to do.

@ivan-nginx
Copy link
Member Author

@stevenjoezhang first of all, u need to join with any supported messengers for NexT, or suggest another one. I suggest to join in Telegram.

@ivan-nginx
Copy link
Member Author

@stevenjoezhang please, write me PM in Telegram, I can't to find you there.

@ivan-nginx
Copy link
Member Author

ivan-nginx commented Mar 31, 2019

@stevenjoezhang so, how we can add to auto-launch this script? Maybe directly in Netlify, this script will be check for new versions and generate if needed?

@stevenjoezhang
Copy link
Contributor

so, how we can add to auto-launch this script?

Perhaps we can use another script to get the update, and then send PR to the repository

@theme-next theme-next deleted a comment from stale bot Oct 29, 2019
@stevenjoezhang stevenjoezhang changed the title NexT Docs NexT v7 Docs Mar 11, 2020
@stevenjoezhang
Copy link
Contributor

Superseded by #88

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests