Skip to content
Snippets Groups Projects
Commit 8b140fd1 authored by Boris Yakobowski's avatar Boris Yakobowski
Browse files

[Doc/release] clarify last steps

parent 25cbf7af
No related branches found
No related tags found
No related merge requests found
...@@ -18,7 +18,6 @@ ...@@ -18,7 +18,6 @@
\input{intro} \input{intro}
\input{branch} \input{branch}
\input{build} \input{build}
\input{website} \input{website}
\end{document} \end{document}
\chapter{The Distribution Stage} \chapter{The Website Stage}
Where all our efforts goes on the web. There are two very different Where all our efforts goes on the web. There are two very different
tasks for \FramaC to go online. Authoring the web site pages is the tasks for \FramaC to go online. Authoring the web site pages is the
...@@ -6,10 +6,15 @@ responsibility of the developpers and the release manager. Publishing ...@@ -6,10 +6,15 @@ responsibility of the developpers and the release manager. Publishing
the web site can only be performed by authorized peoples, who may not the web site can only be performed by authorized peoples, who may not
be the release manager. be the release manager.
\section{Requirements}
You need \texttt{pandoc} and \texttt{tidy} to perform those steps.
They can be installed from your Linux distribution.
\section{Authoring the Pages} \section{Authoring the Pages}
To edit the web pages of the site, developpers only need the To edit the web pages of the site, developpers only need the
\texttt{trunk} branch of the repository. The web site sources are in \texttt{trunk} branch of the repository. The web site sources are in
\texttt{doc/www/src}. \texttt{src} or the checkout of the \texttt{website} tree.
\subsection{Editing Web Pages} \subsection{Editing Web Pages}
...@@ -21,8 +26,9 @@ Compile the web pages with: ...@@ -21,8 +26,9 @@ Compile the web pages with:
\$ make local \$ make local
\end{shell} \end{shell}
Here, you get a snapshot of the web-site in \texttt{doc/www/src}, This way, you get a snapshot of the web-site in \texttt{src},
without any downlable resources. without any downloadable resources. You can start browsing at
\texttt{index.html}
\subsection{Adding News} \subsection{Adding News}
The news are defined in the \texttt{news.def} page. All the news The news are defined in the \texttt{news.def} page. All the news
...@@ -75,17 +81,16 @@ The current (\emph{awkward}) procedure is as follows: ...@@ -75,17 +81,16 @@ The current (\emph{awkward}) procedure is as follows:
You should at least update the links to reference documentation from the You should at least update the links to reference documentation from the
\texttt{support.prehtml} page. \texttt{support.prehtml} page.
\end{enumerate} \end{enumerate}
\item Add the page \texttt{install-NAME} where \texttt{NAME} is the version \item Copy the file \texttt{INSTALL.md} from Frama-C to
name of the distribution (diff the file \texttt{INSTALL} of the previous \texttt{INSTALL-NAME.md} where \texttt{NAME} is the version name of the
release with \texttt{TRUNK/INSTALL} and update \texttt{install-PREVIOUS-NAME} distribution.
accordingly).
\item Build the web site: \item Build the web site:
\begin{shell}[gobble=4] \begin{shell}[gobble=4]
\$ make local \$ make local
\$ make distrib \$ make distrib
\end{shell} \end{shell}
You get a snap-shot of the repository in the newly created You get a snap-shot of the repository in the \texttt{www} directory.
\texttt{doc/www/distrib} directory. Test it carefully.\\ Test it carefully.\\
Automatic testing for compliance to \textsf{W3C} and links consistency Automatic testing for compliance to \textsf{W3C} and links consistency
was launched (install the required tools before if necessary). was launched (install the required tools before if necessary).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment